Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 2.75 KB
Raw

Contributing to BooleanCat/option

Contributions to this project are very welcome! This guide should help with instructions on how to submit changes. Contributions can be made in the form of GitHub issues or pull requests.

When submitting an issue, please choose the relevant template or choose a blank issue if your query doesn't naturally fit into an existing template.

TL;DR contribution checklist

  • My code is formatted (make check)
  • I have run tests (make test)
  • My code has no lint errors (make lint)
  • All commits in my PR conform to the commit hygiene section
  • I have added relevant tests
  • I have not added any dependencies

Zero-dependency

This project is a zero-dependency project - which means that consumers using this project's packages must only incur one dependency: option.

Development dependencies are OK as they will not be included as dependencies to end-users (such as golangci-lint).

Commit hygiene

  • Commits should contain only a single change
  • Commit messages must use imperative language (e.g. Add iter.Fold collection function)
  • Commit messages must explain what is changed, not how it is changed
  • The first line of a commit message should be a terse description of the change containing 72 characters or fewer

Running tests

Run tests with make test from the project root directory.

Tests are written using Go's testing package and helpers are available in internal/assert.

Code is linted using golangci-lint. The linter may be run using make lint.

Different types of changes

Bug fixes

Bug reports are appreciated ahead of bug fixes as early reporting allows the community to be aware of any issues ahead of a fix being submitted. If you intend to fix a bug after reporting, that is greatly appreciated - just make sure to mention you intend to work on it on the issue report so the maintainers are aware and leave you the chance to make a contribution.

When submitting a bug fix PR, a test must be added (or an existing test modified) that exposes the bug and your change must make that test pass.

New features

Issues should be opened ahead of submitting a PR to added a new feature. This is to prevent you wasting your time should a feature not be desirable and allows others to have input into the conversation.

All new functionality must be fully tested and new public functions must include an Example test that will be used by the reference docs to demonstrate its use.

Mark pull requests as "Draft" if you intend to use the pull request as a workspace but are not yet ready to receive unsolicited feedback on specifics like commit messages or failing tests.