Skip to content

Contributing

Jump to bottom
B. K. Oxley (binkley) edited this page May 10, 2024 · 8 revisions

Contributing

See CONTRIBUTING.md.

Please file issues, or contribute pull requests. And fork this project if that makes sense to you.

I'd love a conversation with you!

Creative Commons Zero 1.0 Universal

See the code repo for working examples.
This work is dedicated/deeded to the public following laws in jurisdictions for such purpose. The principal authors are:

You can always use the "Pages" UI control above this sidebar ☝ to navigate around all pages alphabetically (even pages not in this sidebar), to navigate the outline for each page, or for a search box.

Here is the suggested reading order:

Title page

Frontispiece

About the authors

Preface

Acknowledgements

Introduction

Terms

Getting started

Try it

Reusing this project

Getting your project started

Use Gradle or Maven

The JDK

The pipeline

Setup your CI

Keep local consistent with CI

Dependency management

Maintain your build

Choose your code style

Shift security left

Document your code

Generate code

Leverage the compiler

Use static analysis

Leverage unit testing and coverage

Use mutation testing

Use integration testing

Monitor and report your build

Other topics

Commits

Cycle time

Debugging

Performance problems

Other problems

Example projects

Going further

Thank you!

Contributing

Clone this wiki locally