From f068b54513d6cdccab58d41c37970fba037bd788 Mon Sep 17 00:00:00 2001 From: Ajay Jadhav Date: Sat, 2 Sep 2023 01:10:55 +0530 Subject: [PATCH] docs: add CONTRIBUTING guidelines --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..38e4fde7e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +## How to contribute + +You are encouraged to contribute to the repository by **forking and submitting a pull request**. + +For significant changes, please open an issue first to discuss the proposed changes to avoid re-work. + +(If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git) and check out a more detailed guide to [pull requests](https://help.github.com/articles/using-pull-requests/).) + +Pull requests will be evaluated by the repository guardians on a schedule and if deemed beneficial will be committed to the `main` branch. Pull requests should have a descriptive name, include an summary of all changes made in the pull request description, and include unit tests that provide good coverage of the feature or fix. A Continuous Integration (CI) pipeline is executed on all PRs before review and contributors are expected to address all CI issues identified. Where appropriate, PRs that impact the +end-user and developer demos (if any) in the repo should include updates or extensions to those demos to cover the new capabilities. + +If you would like to propose a significant change, please open an issue first to discuss the work with the community. + +Contributions are made pursuant to the Developer's Certificate of Origin, available at [https://developercertificate.org](https://developercertificate.org), and licensed under the Apache License, version 2.0 (Apache-2.0). \ No newline at end of file