Skip to content

Latest commit

 

History

History
12 lines (8 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

12 lines (8 loc) · 1.27 KB

Contributions to the module

I'm thrilled that you want to contribute to the module, thanks! 🥳

To make it easier for you to contribute I've added some notes about what to keep in mind when contributing to this repository.

Bug and Feature requests

The best way to report a bug or feature request on this project is to use the issues panel in the repository. Please mark the ticket with either [BUG] or [FEATURE REQUEST] in the start of the title to make it easy for maintainers to catagorise what's submitted. It's always nice to check the existing reports to see if anyone else has the same bug or request as you. If that's the case then you should rather give that ticket a upvote and follow the ticket. This helps the maintaner prioritise the tickets, resulting in you geting your requested feature or bugfix implemented faster.

Pull requests

By default we squash changes on the main banch to keep the Git-log clean, and then make sure that the squash commit includes the Pull request number so we can go back and see in more details.

Always make sure that all tests and workflows passes whenever you've made a change. Any changes that requires the end-user of this repository to make changes to their implementation of the module should be noted clearly in the pull request.