Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added CONTRIBUTING.md ✨ #95

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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! 🌟