Thank you for investing your time in contributing to the OpenData Community! We are excited to build an Open Data Layer for Web3 with you and all of our partners!.
-
We have created working groups that you can get involved in. Please refer to our discord for more info
-
We are using discord for the community and general coordination.
-
And we are using this Github repo for contributions and building in public.
-
You can find our calendar of meetings and events here
Here is the flow if you are NOT a member of the ODC Organization on Github
- Sign in to your Github Account
- Go to the ODC Resources Repo
-
The easiest way to start contributing is to check out our Github Issues
-
Scan through them to find one that suits you.
-
Click on the file requiring editing or Create a new file if the task requires it.
-
You can edit existing files by pressing on the crayon icon on the right side of the page
- When you are done working on the file, click PROPOSE CHANGE at the bottom of the file. This will automatically create a new fork and branch. We suggest using a branch name similar to
<user>-<patch><#>, e.g. sarob-patch12.
- You will then need to create a Pull Request (follow the prompt)
- Save the PR. If there is a open issue associated with your PR, add the issue # into either the summary or description field as
#<number>, e.g. the issue number is 32, so add#32.
-
Make sure to keep the checkmark that says "allow edits by maintainers" checked (this allows us to edit your proposed change)
-
PR's need to be reviewed by at least 1 other member of the ODC before merging.
-
You can post the link to your PR request in our discord for review
-
Once you submit your PR, a ODC member will review your work. We may ask questions, comment, edit
-
Once your PR is merged, your contributions will be publicly visible in the repository.
Congratulations & Thank You! You have contributed to the ODC Community
If you ARE a member of the ODC Organization on Github and using this method
- The only difference is when you create your PR, you can assign a reviewer directly and do not need to post the PR link in discord to attract the attention of a reviewer
Alternatively if like to work offline using your local laptop, follow the steps below.
Firstly you can become a member of the ODC GitHub organization. Simply join the ODC discord ask in the general channel to be added. ODC discord members in good standing can be ODC github organization members. This means you will have write access to repositories in the ODC organization.
-
If you are new to github, we suggest using Visual Studio Code, an IDE for editing file. Getting started with Visual Studio Code will guide you through setting up VSC.
-
If you are a seasoned github user, feel free to use the applications you are comfortable with and follow the guidelines below.
-
The first step is to clone ODC Resources
-
For new github users, we suggest following the promps in Visual code, for seasoned users you can use whatever you like.
-
Find the file you want to make changes to or create a new file if that is what the task requires.
-
Create a new branch to work on. We suggest using a branch name similar to
<user>-<patch><#>, e.g. sarob-patch01. -
Create a fix and when it is ready submit a PR to the original Repo
-
PR's need to be reviewed by at least 1 other member of the ODC before merging. Please assign a reviewer in your PR and label it accordingly.
-
The description field in the PR is optional.
-
If there is an issue associated with your PR, add the issue # into either the summary or description field as
#<number>, e.g. the issue number is 32, so add#32. -
Once you submit your PR, a ODC member will review your work. We may ask questions or request additional information.
-
Once your PR is merged, your contributions will be publicly visible in the repository.