From 8764084accd5593092efab83d120ba6101f4ae38 Mon Sep 17 00:00:00 2001 From: Jonas van den Bogaard <3628277+Jonasvdbo@users.noreply.github.com> Date: Fri, 2 Sep 2022 10:01:24 +0200 Subject: [PATCH 1/2] Create CONTRIBUTING.md Added the standard GXF contribute file to this repo. Signed-off-by: Jonas van den Bogaard <3628277+Jonasvdbo@users.noreply.github.com> Signed-off-by: Jonas van den Bogaard <3628277+Jonasvdbo@users.noreply.github.com> --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..00bba31 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# 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://documentation.gxf.lfenergy.org/Opensourcecommunity/Code-of-conduct.html) + +## 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://documentation.gxf.lfenergy.org/Opensourcecommunity/Governance.html). + +If you have any questions, open an issue. + +## Developer tools and technical guidelines + +Please find the [developer tools and technical guidelines here](https://documentation.gxf.lfenergy.org/Opensourcecommunity/ToolsguidelinesCI.html). + +## Documentation guidelines + +Please find the [documentation guidelines here](https://documentation.gxf.lfenergy.org/Opensourcecommunity/Contributing-to-documentation.html). + +## Contribution guidelines + +Please find the [more detailed contribution guidelines here](https://documentation.gxf.lfenergy.org/Opensourcecommunity/Contributing-to-the-code.html). + +## 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://documentation.gxf.lfenergy.org/Opensourcecommunity/Governance.html) 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. From 8cfbe6752e978bf6dbf0f7baa883d9584f63b601 Mon Sep 17 00:00:00 2001 From: Jonas van den Bogaard <3628277+Jonasvdbo@users.noreply.github.com> Date: Wed, 1 Feb 2023 16:16:11 +0100 Subject: [PATCH 2/2] Update CONTRIBUTING.md Signed-off-by: Jonas van den Bogaard <3628277+Jonasvdbo@users.noreply.github.com> Signed-off-by: Jonas van den Bogaard <3628277+Jonasvdbo@users.noreply.github.com> --- CONTRIBUTING.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00bba31..df213c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ We'd love to accept your patches and contributions to this project. There are ju ## Code of conduct -Please comply with the [code of conduct](https://documentation.gxf.lfenergy.org/Opensourcecommunity/Code-of-conduct.html) +Please comply with the [code of conduct](https://grid-exchange-fabric.gitbook.io/gxf/opensourcecommunity/code-of-conduct) ## To get started @@ -16,26 +16,27 @@ Please comply with the [code of conduct](https://documentation.gxf.lfenergy.org/ 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://documentation.gxf.lfenergy.org/Opensourcecommunity/Governance.html). +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://documentation.gxf.lfenergy.org/Opensourcecommunity/ToolsguidelinesCI.html). +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://documentation.gxf.lfenergy.org/Opensourcecommunity/Contributing-to-documentation.html). +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://documentation.gxf.lfenergy.org/Opensourcecommunity/Contributing-to-the-code.html). +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://documentation.gxf.lfenergy.org/Opensourcecommunity/Governance.html) for more information on the 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. +