Skip to content

Latest commit

 

History

History
105 lines (76 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

105 lines (76 loc) · 2.69 KB

Contributing

Pull Requests

We love pull requests from everyone. By participating in this project, you agree to abide by its Code of Conduct.

  1. Fork and clone the repo.

  2. Build and make sure all tests pass:

    $ ./configure
    $ make test
  3. Make your changes.

    Respect the existing formatting and indentation, when in doubt consult style(9).

  4. If your changes can be captured by a test, make sure to add one. Changes that only concern the interface can be harder to test but feel free to ask for help.

    Again, make sure all tests still pass.

  5. If your changes for instance adds an option or key binding, make sure to update the manual.

  6. Submit a pull request on GitHub. This will in addition to sharing your work run it through our continuous integration which performs both static and runtime analysis in order to catch bugs early on.

  7. At this point you're waiting on us.

Release

Internal documentation on crafting a release.

  1. Run Coverity Scan. In the case of discovered defects, perform a fix and redo this step until no further defects are detected.

    $ git checkout coverity_scan
    $ git rebase master
    $ git push origin coverity_scan
  2. Update CHANGELOG.md and commit the change:

    $ git commit -m 'update changelog'
  3. Update the version in Makefile and commit the change:

    $ git commit -m 'update version to 0.0.2'
  4. Create and verify the tarball:

    $ make dist
  5. Tag and push:

    $ git tag v0.0.2
    $ git push --tags origin master
  6. Announce the release on GitHub.

  7. Contact package maintainers: