Skip to content

Create CONTRIBUTING.md #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jonasvdbo wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Create CONTRIBUTING.md #45

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8764084
Create CONTRIBUTING.md
Jonasvdbo Sep 2, 2022
8cfbe67
Update CONTRIBUTING.md
Jonasvdbo Feb 1, 2023
529ce5e
Merge branch 'main' into patch-2
jasperkamerling Feb 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.