Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 5.97 KB

CONTRIBUTING.md

File metadata and controls

95 lines (68 loc) · 5.97 KB
Raw

💁 Contributing to this project

First off, thank you for considering contributing to this project.
It’s people like you that keep this project alive and make it great!
Thank you! 🙏💜🎉👍

The following is a set of guidelines for contributing to this project. Use your best judgment and feel free to propose changes to this document in a pull request.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

💡 Your contribution - the sky is the limit 🌈

This is an open source project and we love to receive contributions from our community — you!

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and enhancement or writing code which can be incorporated into the repository itself.

When contributing to this project, please feel free to discuss the changes and ideas you wish to contribute with the repository owners before making a change by opening a new issue and add the feature request tag to that issue.

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

🐞 You want to report a bug or file an issue?

  1. Ensure that it was not already reported and is being worked on by checking open issues.
  2. Create a new issue with a clear and descriptive title
  3. Write a detailed comment with as much relevant information as possible including
  • how to reproduce the bug
  • a code sample or an executable test case demonstrating the expected behavior that is not occurring
  • any files that could help trace it down (i.e. logs)

🩹 You wrote a patch that fixes an issue?

  1. Open a new pull request (PR) with the patch.
  2. Ensure the PR description clearly describes the problem and solution.
  3. Link the relevant issue if applicable (how to link issues in PRs).
  4. Ensure that no tests are failing and coding conventions are met
  5. Submit the patch and await review.

🎁 You want to suggest or contribute a new feature?

That's great, thank you! You rock 🤘

If you want to dive deep and help out with development on this project, then first get the project installed locally. After that is done we suggest you have a look at tickets in our issue tracker. You can start by looking through the beginner or help-wanted issues:

  • Good first issues are issues which should only require a few lines of code, and a test or two.
  • Help wanted issues are issues which should be a bit more involved than beginner issues. These are meant to be a great way to get a smooth start and won't put you in front of the most complex parts of the system.

If you are up to more challenging tasks with a bigger scope, then there are a set of tickets with a feature, enhancement or improvement tag. These tickets have a general overview and description of the work required to finish. If you want to start somewhere, this would be a good place to start. That said, these aren't necessarily the easiest tickets.

For any new contributions please consider these guidelines:

  1. Open a new pull request (PR) with a clear and descriptive title
  2. Write a detailed comment with as much relevant information as possible including:
  • What your feature is intended to do?
  • How it can be used?
  • What alternatives where considered, if any?
  • Has this feature impact on performance or stability of the project?

Your contribution responsibilities

Don't be intimidated by these responsibilities, they are easy to meet if you take your time to develop your feature 😌

  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Ensure (cross-)platform compatibility for every change that's accepted. An addition should not reduce the number of platforms that the project supports.
  • Ensure coding conventions are met. Lint your code with the project's default tools. Project wide commands are available through the Makefile in the repository root.
  • Add tests for your feature that prove it's working as expected. Code coverage should not drop below its previous value.
  • Ensure none of the existing tests are failing after adding your changes.
  • Document your public API code and ensure to add code comments where necessary.

⚙️ How to set up the environment

Please consult the README for installation instructions.