We welcome contributions from all members of our community, including developers, designers, and other contributors who are interested in helping us build and improve our products and services.
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
- Becoming a maintainer
We appreciate your interest in contributing to our project. Before you get started, please review our contributors policy to ensure that your contribution aligns with our goals and expectations.
Pull requests are the best way to propose changes to the codebase (we use Github Flow).
Designed to help us maintain a high level of quality and consistency in our codebase, while also providing clear guidelines and expectations for contributors. By making a contribution, you agree to abide by the following guidelines:
-
How to make a contribution: Contributions should be submitted via pull request. Please provide a clear and descriptive title and description for your pull request, and ensure that your code has been tested and reviewed before submitting.
-
COMING SOON Code standards: All contributions must adhere to our coding standards and best practices. Please review our code style guide and follow its recommendations.
-
Submission requirements: When making a contribution, please provide clear documentation and test coverage to help ensure that your code is easy to understand and maintain over time.
-
Expectations for contributors: We expect contributors to be responsive to feedback and willing to work collaboratively with our team to improve our codebase. Additionally, we expect all contributions to meet our standards for code quality and professionalism.
-
Legal requirements: Please ensure that any contributions you make are compliant with any applicable legal requirements or licenses.
By making a contribution, you acknowledge that you have read and understood our contributors policy, and agree to abide by its guidelines and expectations. We look forward to working with you, and appreciate your commitment to helping us build and maintain high-quality products and services.
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 harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
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.
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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. 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. Further details of specific enforcement policies may be posted separately.
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.