Search…
Contribute
OxychainDAO will operate autonomously, so everyone is welcome to contribute to this guide. This page outlines the contribution workflow.

Join our community discord

Join our DAO Discord and make sure you fill-up the onboarding form there. Signal your interest in content creation and you will be assigned a corresponding role. After that, you can collaborate with other members of the Content team to further improve this document.
Note: The onboarding process might be subject to change in the future. Worry not, just ask around in the discord and our helpful community will guide you through the onboarding process.

Contributor Workflow

Prerequisite: Be part of the education team in our organization. Not sure how? Join our community in DAO Discord and find out more.
Every contributor should follow this workflow when updating the documentation. At a high level, the workflow is as follows:
  1. 1.
    Clone the GitHub repository onto your local machine.
  2. 2.
    Create a local development branch.
  3. 3.
    Push your branch to the repository.
  4. 4.
    Perform your work in the local branch.
  5. 5.
    Commit your changes and push them to the remote branch regularly as your work progresses.
  6. 6.
    When the development is complete, submit a pull request on Github.
If you are not familiar with GitHub, check out this guide from GitHub.

First-Time Setup

  1. 1.
    Clone oxychain-earth/documentation GitHub repository.
    git clone [email protected]:oxychain-earth/documentation.git
  2. 2.
    Go to the project directory where you have cloned the repository and issue this command:
    git status
  3. 3.
    You should see the following output in your terminal:
    On branch masterYour branch is up to date with 'origin/master'.nothing to commit, working tree clean
  4. 4.
    You have now successfully cloned the GitHub repository and you can start making changes locally.

Create a Branch

After you have cloned the repository, you can start making changes to the documentation. All changes should be done in a separate branch before they can be merged to the master branch (i.e. become official).
  1. 1.
    Go to the master branch and synchronize it with the repository.
    1
    git checkout master
    2
    git pull
    3
    Copied!
  2. 2.
    Create a branch to work on your changes. We name it foo in this example.
    1
    git checkout -b foo
    2
    Copied!
  3. 3.
    Push your branch to the repository so that other members can collaborate with you on the same branch.
    1
    git push -u origin HEAD
    2
    Copied!
  4. 4.
    To verify you have set up your branch correctly, check your working tree status:
    1
    git status
    2
    Copied!
  5. 5.
    The expected output should be:
    On branch fooYour branch is up to date with 'origin/foo'.nothing to commit, working tree clean
  6. 6.
    You can start editing files now and we will show you how to commit your changes in the next section.

Commit Changes

Every time you make a change in the documentation, you can commit the change so that it is recorded by Git. You should also push the change to the repository so that other members can see what you have changed, and most importantly, the repository serves as a backup for your work.
  1. 1.
    Say you have made some changes to the file bar and you want to commit it. First, you need to add it to the staging area:
    1
    git add bar
    2
    Copied!
  2. 2.
    Check your working tree status:
    1
    git status
    2
    Copied!
  3. 3.
    The expected output should be:
    On branch fooYour branch is up to date with 'origin/foo'.Changes to be committed:(use "git restore --staged ..." to unstage)modified: bar
  4. 4.
    Once the modified file is in the staging area, you can commit it:
    1
    git commit
    2
    Copied!
  5. 5.
    This should open your default editor. Write a message that briefly explains your changes and consummate the commit by saving and exiting the file.
  6. 6.
    Finally, you can push your commit to the repository by issuing:
    1
    git push
    2
    Copied!

Make a Pull Request

When you are satisfied with your modification, you can submit a pull request in order to make it official.
  1. 2.
    Select the branch that you are working on.
    [Insert picture selecting the branch]
  2. 3.
    After selecting your branch, click on the "Pull request" button to make a pull request.
    [Insert picture creating pull request]
  3. 4.
    On the pull request page, briefly describe what your modification is about.
  4. 5.
    Add the Core Team as a reviewer so that all members of the Core Team will be notified about this pull request.
  5. 6.
    Lastly, assign this pull request to yourself and submit it.
    [Insert picture assigning pull request to myself]

Merge Your Changes

After your pull request is approved by the Education Team, you can merge your changes to the master branch. This will make your modification official.
  1. 1.
    Go to the Pull Request section and select your pull request.
    [Insert picture of pull requests section]
  2. 2.
    Click "Squash and merge" after your pull request has been approved by the Core Team.
    [Insert picture of Squash and merge]
  3. 3.
    Click "Confirm squash and merge" to finally merge your changes into the master branch.
    [Insert picture of confirm squash and merge]
Last modified 2mo ago