BoneJ contribution guidelines

August 12, 2021 ยท View on GitHub

Prerequisites

  • Familiarize yourself with GitHub
  • Java 8 (newer version is fine, but the project still uses 1.8 bytecode)
  • Maven
  • GitHub and Git
  • Preferrably an IDE such as Eclipse, IntelliJ or NetBeans
    • Eclipse requires the m2e-egit connector to be installed so that you can seamlessly import your BoneJ2 fork from GitHub, but the version in the marketplace is often too old: you may need to install it from the repository.

Getting started

  1. Create a fork
  2. Synchronize your fork
  3. Create a topic branch for your fix / new feature, e.g. fix-issue-#1

Commits

  • Write descriptive commit messages
  • Ideally each commit in the history should build
  • Keep commits small. For example:
    • POM: add dependency
    • Add myMethod
    • Add test
    • Add Javadoc
    • Format code

Creating a pull request (PR)

  1. Before creating a PR:
  • Your code should have tests
  • At least public API should have Javadoc
    • You can check that your Javadoc is valid by running mvn javadoc:javadoc
  • Check that Maven can build BoneJ without errors by running mvn clean package
  1. Create a PR and wait for a review
  2. If team members request changes to your code, add commits until PR is accepted

Licensing

Code added to BoneJ should be licensed under BSD-2.

Finally

Don't let the guidelines discourage you, they are not set in stone. We'll help to get your PR ready!