From 1b269f8357facc8d898eee440885ed70425710b1 Mon Sep 17 00:00:00 2001 From: 0Armaan025 Date: Sat, 21 Oct 2023 10:52:58 +0530 Subject: [PATCH] added CONTRIBUTING.md --- CONTRIBUTING.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f04e3fc3e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# 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 πŸ“œ](#code-of-conduct) +2. [Getting Started πŸš€](#getting-started) + - [Forking the Repository 🍴](#forking-the-repository) + - [Cloning the Repository πŸ“¦](#cloning-the-repository) +3. [Making Changes πŸ› οΈ](#making-changes) + - [Branches 🌿](#branches) + - [Commit Messages πŸ“¦](#commit-messages) + - [Coding Standards πŸ’»](#coding-standards) +4. [Submitting a Pull Request πŸš€](#submitting-a-pull-request) +5. [Code Review πŸ‘οΈ](#code-review) + +## Code of Conduct πŸ“œ + +Please be informed that this project adheres to a [Code of Conduct](LICENSE). 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: + +```bash +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: + +```bash +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! 🌟