Skip to content

Latest commit

 

History

History
114 lines (77 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

114 lines (77 loc) · 3.11 KB

Contributing to Pokerogue Daily Runs

First off, thank you for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to this project on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. Most of the development takes place in our Discord server. Feel free to join and help us out!

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Style Guides
  4. Report Issues

Getting Started

  1. Fork the repo on GitHub.
  2. Clone the project to your own machine.
  3. Commit changes to your own branch.
  4. Push your work back up to your fork.
  5. Submit a Pull Request so that we can review your changes.

How to Contribute

Fork the Repository

  1. Click the "Fork" button on the upper right corner of the repo page.
  2. This creates a copy of the repo under your GitHub account.

Clone the Fork

  1. Clone your fork to your local machine:

    git clone https://github.com/PokeRogue-Projects/pokerogue-daily-runs.git

  2. Navigate into the cloned directory:

    cd pokerogue-daily-runs

Create a Branch

  1. Create a new branch for your changes:

    git checkout -b feature/your-feature-name

Make Your Changes

  1. Make the changes to your code, adding new features or fixing bugs.
  2. Test your changes thoroughly.

Commit Your Changes

  1. Stage your changes:

    git add .

  2. Commit your changes:

    git commit -m "Your descriptive commit message"

Push Your Changes

  1. Push your changes to your forked repository:

    git push origin feature/your-feature-name

Submit a Pull Request

  1. Go to the original repository on GitHub.
  2. Click on the "Pull Requests" tab.
  3. Click the "New Pull Request" button.
  4. Select the branch you just pushed to compare against the main branch of the original repository.
  5. Provide a detailed description of your changes.
  6. Submit the pull request.

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally.

Code Style

  • Follow the style guides relevant to the programming languages used in the project.
  • Ensure your code passes existing tests and add new tests where necessary.

Report Issues

If you find a bug or want to request a feature, please create an issue or message on discord.

Thank you for contributing! 🚀