Skip to content

Latest commit

 

History

History
66 lines (52 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

66 lines (52 loc) · 3.26 KB
Raw

Contributing

Steps to contribute:

Issues

  • Raise an issue in the Issues section if you want to make any enhancement, found a bug, or wish to add a feature
  • Check if anyone else is working on the same issue, if not you may submit a Pull Request for the same

Pull Request

  • Fork the repository by clicking the "Fork" button in the upper right corner of this page.
  • Clone repository to your local machine:
git clone https://github.com/EternoSeeker/gameoflife.git
  • Create a new branch for your contribution:
git checkout -b your-branch-name
  • Test your changes locally to ensure they function correctly.
  • Commit your changes with commit messages that contain the description.
  • You may check Conventional Commits to help you write good commit messages
git commit -m "commit message"
  • Push your changes to your forked repository:
git push origin your-branch-name
  • Open a pull request to the main branch of this repository.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.

If you find any bugs or have any suggestions, please open an issue on GitHub and provide detailed information about the bug or suggestion. Visit the issues section to work on existing issues or you can create your own and work on it.