Skip to content

Contributing to Sylva

Thanks for your interest in contributing to Sylva!

All thoughtful contributions are welcome and appreciated. Newcomers who aren't sure where to start are encouraged to look for issues labeled good first issue for an easy introduction.

Note that these are just guidelines, and reasonable deviation is often acceptable. Just let us know. Sometimes things fall outside of the normal scope of this document.

Note

The keywords MUST, MUST NOT, SHOULD, SHOULD NOT, and MAY are to be interpreted as described in RFC 2119.

General Guidelines

  • All pull requests SHOULD adhere to the Conventional Commits Specification.
  • Contributors SHOULD strive for one commit per realistic change, and one realistic change per commit. All this means is that fixing a typo shouldn't be 12 commits. Be thoughtful.
  • Contributors SHOULD open an issue or discussion prior to starting work on a new feature or large refactor, to ensure the work is in line with the project's goals.

License

Contributors MUST agree that their patch will be licensed under the project's current license, and that the maintainers of the project are free to relicense the project as deemed appropriate.

With the project in its infancy, we may decide a different license is more appropriate for the project. Once we're satisifed with the current license being the most appropriate, this message will be removed.