diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..df213c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# How to Contribute + +We'd love to accept your patches and contributions to this project. There are just a couple guidelines you need to follow before making a change. + +## Code of conduct + +Please comply with the [code of conduct](https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/code-of-conduct) + +## To get started + +1. Fork the repository, do work in a feature branch. + +2. Issue a pull request. + +3. Make sure the automated test suite succeeds. They will show-up in the pull request. + +4. Sign the CLA using [EasyCLA](https://easycla.lfx.linuxfoundation.org/). + +5. Assign a maintainer to accept/evaluate your pull request. The current maintainer can be found in the [documentation](https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/governance). + +If you have any questions, open an issue. + +## Developer tools and technical guidelines + +Please find the [developer tools and technical guidelines here](https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/toolsguidelinesci). + +## Documentation guidelines + +Please find the [documentation guidelines here](https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/contributing-to-documentation). + +## Contribution guidelines + +Please find the [more detailed contribution guidelines here](https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/contributing-to-the-code). + +## Governance + +The basic principle is that decisions are based on consensus. If this decision making process takes too long or a decision is required, the Technical Steering committee has the authority to make a decision. Please read [this page](https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/governance) for more information on the governance. + +## Help + +Don't hesitate to reach out for help by [mentioning](https://github.com/blog/821-mention-somebody-they-re-notified) a maintainer or other relevant contributors. +