Skip to content

Latest commit

 

History

History
113 lines (79 loc) · 3.55 KB

CONTRIBUTING.md

File metadata and controls

113 lines (79 loc) · 3.55 KB
Raw

Contributing to Odin

First off, thank you for considering contributing to our Minecraft mod! We appreciate your time and effort in helping us improve and expand the project.

How to Contribute

Reporting Bugs

If you find a bug in the mod, please report it by creating a new post in our Discord. Please include:

  • A clear and descriptive title.
  • A detailed description of the issue.
  • Steps to reproduce the issue.
  • Any relevant screenshots or logs.

Suggesting Features

If you have an idea for a new feature or an enhancement to an existing feature, we'd love to hear about it! Please open a new post in our Discord and include:

  • A clear and descriptive title.
  • A detailed description of the proposed feature.
  • Any potential use cases or benefits.

Contributing Code

We welcome contributions from everyone. Here are the steps to get started:

1. Fork the Repository

  1. Navigate to the Repository: Go to the GitHub page of the repository you want to contribute to.

  2. Fork the Repository: Click the Fork button at the top right of the repository page. This creates a copy of the repository under your GitHub account.

2. Clone the Forked Repository

  1. Clone the Repository: On your GitHub page, navigate to the forked repository and click the "Code" button. Copy the URL provided.

  2. Run Git Clone Command: Open your terminal and run:

    git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git

    Replace YOUR_USERNAME with your GitHub username and REPOSITORY_NAME with the name of the repository.

  3. Navigate to the Project Directory:

    cd REPOSITORY_NAME

3. Create a Branch for Your Changes

  1. Create a New Branch: 
    git checkout -b your-branch-name
    Use a descriptive name for your branch, such as feature/update-readme or bugfix/fix-typo.

4. Make Your Changes

  1. Make Necessary Changes: Edit the files in your favorite text editor or IDE.

  2. Stage Your Changes:

    git add .

  3. Commit Your Changes:

    git commit -m "A brief description of your changes"

5. Push Your Changes to GitHub

  1. Push Your Branch to GitHub: 
    git push origin your-branch-name

6. Create a Pull Request

  1. Navigate to the Odin Repository: Go to the Odin repository where you want to contribute.

  2. Open Pull Requests Tab: Click on the "Pull Requests" tab, then click the "New Pull Request" button.

  3. Select Your Branch: Choose the branch you made changes to from your forked repository.

  4. Create the Pull Request: Add a title and description for your pull request, explaining what changes you made and why. Then click the "Create Pull Request" button.

7. Respond to Feedback

  1. Monitor Your Pull Request: Reviewers may provide feedback or request changes. Be sure to respond and make any necessary updates.

  2. Push Additional Changes: If you need to make additional changes, commit them to your branch and push them. The pull request will automatically update with your new commits.

git add .
git commit -m "Address review feedback"
git push origin your-branch-name

Conclusion

Congratulations! You’ve successfully forked a repository, made changes, and created a pull request. This is the typical workflow for contributing to open-source projects on GitHub. Happy coding!