Skip to content

Instantly share code, notes, and snippets.

@pablofullana
Last active June 8, 2023 15:35
Show Gist options
  • Save pablofullana/058843c42c85b07f5809f88c19bc2099 to your computer and use it in GitHub Desktop.
Save pablofullana/058843c42c85b07f5809f88c19bc2099 to your computer and use it in GitHub Desktop.
Generic CONTRIBUTING.md file

How to contribute

Hello there. Looks like you are interested in contributing to , which is just great, so welcome!

We are open to any kind of contribution: code, documentation, bug-fixing (even just reports), feature-requests and anything else you may come up with.

Getting started

Roadmap

There's a (tentative) roadmap in which we've put down what we envision to be the best-next functionalities.

Since the project is constantly evolving and new features are requested/discovered as we go, this roadmap is open for discussions and we expect it to change over time.

Roadmap-wise contributions via new issues are always welcomed.

Discussion

gitter channel reference here

Contributing

Coding

Nothing fancy here, just:

  1. Fork this repo
  2. Commit you code
  3. Submit a pull request. It will be reviewed by maintainers and they'll give you proper feedback so you can iterate over it.

Considerations

Testing

As mentioned above, existing tests must pass and new features are required to be tested and fully-covered.

Documenting

Code should be self-documented. But, in case there is any code that may be hard to understand, it must include some comments to make it easier to review and maintain later on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment