Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (44 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 2.92 KB

Contributing Guidelines 📝

Welcome to the Pokemon Red Experiments project! We extend a warm invitation to you as a potential contributor. Kindly peruse these guidelines to facilitate a harmonious and productive partnership.

Table of Contents 📚

  1. Code of Conduct 📜
  2. Getting Started 🚀
  3. Making Changes 🛠️
  4. Submitting a Pull Request 🚀
  5. Code Review 👁️

Code of Conduct 📜

Please be informed that this project adheres to a Code of Conduct. We expect all contributors to honor these community standards. We encourage you to review this document for a comprehensive understanding of our ethical guidelines.

Getting Started 🚀

Forking the Repository 🍴

If you haven't already, commence by creating a fork of this repository on your personal GitHub account. You may execute this by selecting the 'Fork' button located in the upper right corner of the repository page.

Cloning the Repository 📦

Post-fork, clone the repository onto your local machine using the following command:

git clone https://github.com/YourUsername/PokemonRedExperiments.git

Kindly replace YourUsername with your GitHub username.

Making Changes 🛠️

Branches 🌿

Prior to implementing any modifications, establish a new branch for your work. Endeavor to employ concise and descriptive names for your branches:

git checkout -b feature/your-feature

Commit Messages 📦

Compose clear and informative commit messages. An exemplary commit message ought to concisely elucidate the essence of the commit's alterations. In cases where the commit resolves a specific issue, we recommend referencing the issue number in the commit message. For instance:

feat: Add new Pokémon sprite (#123)

Coding Standards 💻

We kindly request adherence to the project's coding standards. In the event the project prescribes particular code formatting guidelines, kindly ensure your code aligns with these standards.

Submitting a Pull Request 🚀

When your contributions are prepared, adhere to the ensuing steps for Pull Request submission:

  1. Ensure your branch is synchronized with the latest changes from the main branch.
  2. Commit and push your alterations to your fork of the repository.

Code Review 👁️

Subsequent to the submission of your Pull Request, anticipate a thorough review process by the project maintainers and collaborators. Your cooperation in addressing feedback and making necessary adjustments is greatly appreciated.

We eagerly await your valuable contributions to the Pokemon Red Experiments project! 🌟