Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 1.92 KB
Raw

Contributing

Glad to see you want to contribute to this project

Set up

To start contributing, follow these steps:

  • Step 1:

    • Fork this repository by clicking the "Fork" button on the repository page. This creates a copy of the repository under your GitHub account.

  • Step 2:

    • Clone your forked repository to your local machine using the git clone command.
        $ git clone https://github.com/open-xyz/openxyz.git

  • Step 3:

    • Install any necessary dependencies by running the appropriate command for your project. This will depend on the programming language and tools used in the project. For example, if the project is a Node.js application, you would run:
        $ npm install

  • Step 4:

    • Create your own branch, you can create a new branch with the following command:
        $ git checkout -b <branch-name>
    • Replace with the name you want to give to your new branch.

  • Step 5:

    • Switch to your branch, after switching to your branch you can start making changes to your code. When you are ready to commit your changes, run the following commands:
        $ git add .
    $ git commit -m "Your commit message"

  • Step 6:

    • Push your changes to your forked repository using
        git push origin <branch_name>.
    • Replace with the name of the branch you just created.

  • Step 7:

    • Navigate to your forked repository on GitHub, and click the "New pull request" button.

  • Step 8:

    • Select the branch that contains your changes from the "base" dropdown menu, and select the branch you want to merge into the base branch from the "compare" dropdown menu. Add a title and description for your pull request that clearly explains the changes you made.

  • Step 9:

    • Click "Create pull request" to submit your pull request for review.