-
Notifications
You must be signed in to change notification settings - Fork 18
Contributing
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 messagefor example feat(calendar) add event message
fix(subject): short messagefor example fix(calendar) fix date format
Please configure your Editor to respect rules described in the .editorconfig file
OUR PLEDGE In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a positive experience for everyone, regardless of level of experience or nationality.
OUR STANDARDS Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
OUR RESPONSIBILITIES Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
SCOPE This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
ENFORCEMENT Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions, as determined by other members of the project's leadership.