Skip to content

Latest commit

 

History

History
115 lines (71 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

115 lines (71 loc) · 3.95 KB
Raw

Contributing to Formation-Absent

Welcome to Formation-Absent! We're thrilled that you're interested in contributing. Before getting started, please take a moment to review this guide to understand how you can contribute to our project effectively.

Getting Started

Forking the Repository

  1. Navigate to the original repository.
  2. Click on the Fork button in the upper right corner to create a copy of the repository in your GitHub account.

Cloning the Repository

  1. Clone the forked repository to your local machine by running the following command in your terminal:

    git clone https://github.com/GameSphere-MultiPlayer/Formation-Absent.git

Setting Up Remote Upstream

  1. Add a remote upstream to the original repository by running the following command in your terminal:

    git remote add upstream https://github.com/GameSphere-MultiPlayer/Formation-Absent.git

  2. Check the remotes for this repository.

    git remote -v

  3. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

    git pull upstream main

Creating a New Branch

  1. Create a new branch for your changes by running the following command in your terminal:

    git checkout -b <your-branch-name>

Making Changes

Writing Proper Code

  1. Ensure that your code adheres to the project's coding standards and conventions.
  2. Write clear and concise code that is easy to understand and maintain.

Adding Comments

  1. Include comments in your code to explain complex sections or logic.
  2. Use descriptive variable and function names to make the code self-explanatory.

Testing Your Changes

  1. Test your changes locally to ensure they work as expected.
  2. Run any relevant tests provided in the project to verify that your changes haven't introduced any regressions.

Testing Before Creating a Pull Request

  1. Before creating a pull request, thoroughly test your changes in a staging environment if possible.
  2. Make sure your changes don't break existing functionality and that they fulfill the intended purpose.

Committing Changes

  1. Commit your changes with a descriptive message by running the following command in your terminal:

    git commit -m "<your-commit-message>"

Pushing Changes

  1. Push your changes to your forked repository by running the following command in your terminal:

    git push origin <your-branch-name>

Creating a Pull Request

Using Command Line

  1. Navigate to your forked repository on GitHub.
  2. Click on the Compare & pull request button next to your branch.
  3. Review your changes and provide a title and description for your pull request.
  4. Click on the Create pull request button to submit your pull request.

Using GitHub Desktop

  1. Open GitHub Desktop and log in to your GitHub account.
  2. Ensure you're on the correct branch and commit your changes.
  3. Push your changes to your forked repository.
  4. Navigate to your forked repository on the GitHub website and click on the Compare & pull request button.
  5. Review your changes and provide a title and description for your pull request.
  6. Click on the Create pull request button to submit your pull request.

Code of Conduct

Please ensure that you abide by our Code of Conduct during your interactions within our community.

Getting Help

If you need any assistance or have questions, feel free to reach out to one of the project maintainers. You can also join our Discord server for real-time communication and support.

Thank you for considering contributing to Formation-Absent! Your efforts help make this project better for everyone. We appreciate your time, dedication, and passion for open source collaboration.