Skip to content

Latest commit

 

History

History
97 lines (73 loc) · 5.07 KB

CONTRIBUTING.md

File metadata and controls

97 lines (73 loc) · 5.07 KB
Raw

Contributing

Commitizen friendly Semantic Versioning

When contributing to this repository, it is usually a good idea to first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. This could potentially save a lot of wasted hours.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Development

Commit Message Format

All commits in the repository follow the Conventional Changelog standard. It is a very simple format so you can still write commit messages by hand. However it is highly recommended developers install Commitizen, it extends the git command and will make writing commit messages a breeze. All the OpenNARS repositories are configured with local Commitizen configuration scripts.

Getting Commitizen installed is usually trivial, just install it via npm. You will also need to install the cz-customizable adapter which the repository is configured to use.

npm install -g [email protected] [email protected]

Below is an example of Commitizen in action. It replaces your usual git commit command with git cz instead. The new command takes all the same arguments however it leads you through an interactive process to generate the commit message.

Commitizen friendly

Commit messages are used to automatically generate our changelogs, and to ensure commits are searchable in a useful way. So please use the Commitizen tool and adhere to the commit message standard or else we cannot accept Pull Requests without editing them first.

Below is an example of a properly formated commit message.

chore(Commitizen): Made repository Commitizen friendly.

Added standard Commitizen configuration files to the repo along with all the custom rules.

ISSUES CLOSED: #31

Pull Request Process

  1. Ensure that binaries such as build dependencies do not appear in any commits in your code branch.
  2. Ensure all commit messages follow the Conventional Changelog standard explained earlier.
  3. Update the CHANGELOG.md file to add relevant details describing any changes you've made.
  4. Update the CONTRIBUTORS.md file to add your name to it if it isn't already there (one entry per person).
  5. If applicable adjust the project version to the new version that this Pull Request would represent. The versioning scheme we use is Semantic Versioning.
  6. Your pull request will either be approved or feedback will be given on what needs to be fixed to get approval. We usually review and comment on Pull Requests within 48 hours.

Making a Release

Only administrators with privilages to push to the Maven Central account can deploy releases. If this isn't you then you can just skip this section.

First ensure the package is prepared for the release process:

  • Make sure any references to the version number in the readme is updated
    • Version number in dependency maven snippet.
    • Add new version to javadoc version list.
  • Ensure that none of the dependencies used are snapshots.
  • Update the changelog file.
  • Check that all libraries used as dependencies point to the latest version.

Next lets take a few steps to do the actual release:

  1. Update everything listed above. Do not drop the package version's -SNAPSHOT suffix in master.
  2. Create a release branch, but make sure never to push this branch to the server: git checkout -b release.
  3. Update the README.md again to ensure travis badge and javadoc badge point to static tag and not latest.
  4. Drop the -SNAPSHOT suffix from the package version.
  5. Commit the current changes using a generic commit message such as build(release): version 1.2.3.
  6. Fully test the software before deploying, run all tests and install locally to test against the examples package. You can install the package locally with mvn clean install.
  7. Once satisfied the package is stable deploy it to maven central by executing mvn -P sign clean package deploy.
  8. If deployment was successful then create a new tag for the current version with the following command: git tag -a v1.2.3 -m "Version 1.2.3".
  9. Push the newly created tags to the server: git push origin v1.2.3:v1.2.3.
  10. Go to Github and go to the release. Update the description with the changelog for the version and upload all the artifacts in the target folder.
  11. Checkout master again and then delete the release branch: git branch -D release.
  12. Bump the snapshot version of the package to the next expected version, commiting the changes and pushing.
  13. Deploy the new snapshot to the snapshot repository (no need to sign): mvn clean deploy.