-
Notifications
You must be signed in to change notification settings - Fork 17
Contributing
Ibrahim ZEHHAF edited this page May 21, 2022
·
1 revision
Thank you for choosing to contribute to this noble project.
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
We use github to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Create your branch from
main
. - If you've changed APIs, update the documentation.
- Make sure your code lints.
- Issue that pull request!
- One issue = one branch = one pull request
- The name of a branch must be like this
issue/[issueNumber]-short-desc
, for exampleissue/231-add-notification-bip
- After creating the PR DO NOT amend commits to the first one
- Your commit messages must be short and clear and it should respect this patten
feat(subject): short message
for example feat(calendar) add event message
fix(subject): short message
for example fix(calendar) fix date format
Please configure your Editor to respect rules described in the .editorconfig file