Skip to content

Commit

Permalink
Fixed #69 : Missing Contributing.md file and provided clear guideline (
Browse files Browse the repository at this point in the history
…#77)

Missing Contributing.md file
## Description
This pull request enhances the CONTRIBUTING.md file for the Retro by
providing clearer guidelines and a more structured format.


## Related Issues
<!--Cite any related issue(s) this pull request addresses. If none,
simply state “None”-->
- Closes #69 

## Type of PR
<!-- Mention PR Type according to the issue in brackets below and check
the below box -->
- [X] (Documentation update)


## Checklist
<!-- [X] - put a cross/X inside [] to check the box -->
- [X] I have gone through the [contributing
guide](https://github.com/Anjaliavv51/Retro)
- [X] I have updated my branch and synced it with project `main` branch
before making this PR
- [X] I have performed a self-review of my code
- [X] I have tested the changes thoroughly before submitting this pull
request.
- [X] I have provided relevant issue numbers, screenshots, and videos
after making the changes.
- [X] I have commented my code, particularly in hard-to-understand
areas.
  • Loading branch information
Anjaliavv51 authored Oct 2, 2024
2 parents 4a04952 + db0204d commit 875af02
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 0 deletions.
91 changes: 91 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Contributing to Retro

We’re excited that you want to contribute to Retro! The following is a set of guidelines to help you contribute effectively and ensure consistency within the project.

## How to Contribute

### 1. Fork the Repository
Click on the "Fork" button at the top of the repository’s GitHub page. This will create a copy of the repository in your GitHub account.

### 2. Clone the Forked Repository
Clone the forked repository to your local machine using the command below:

```bash
git clone https://github.com/<your-github-username>/Retro
```

### 3. Add Remote Upstream
Add a remote upstream to keep your fork updated with the original repository:

```bash
git remote add upstream https://github.com/original-owner-username/Retro
```

### 4. Create a New Branch
Before making changes, create a new branch for your work:

```bash
git checkout -b <your-branch-name>
```

### 5. Make Your Changes
Make the necessary changes to the codebase.

### 6. Stage Your Changes
Once you’ve made your changes, stage them for commit:

```bash
git add <file1> <file2> ...
```

### 7. Commit Your Changes
Commit your changes with a descriptive message:

```bash
git commit -m "A meaningful message describing the change"
```

### 8. Push Your Changes
Push your changes to your forked repository:

```bash
git push origin <your-branch-name>
```

### 9. Create a Pull Request (PR)
Go to your forked repository on GitHub. You should see a prompt to create a pull request. Compare the changes and create the PR. Ensure to fill in details about the changes you’ve made.

---

## Guidelines

### Reporting Bugs
If you encounter any bugs, feel free to report them. Please ensure you include:
- A clear and descriptive title.
- A description of the issue and how to reproduce it.
- Expected behavior vs. actual behavior.
- Any error messages or logs that might help.

### Suggesting Features or Enhancements
We welcome new ideas and suggestions! To propose a new feature:
- Open an issue with a feature request label.
- Provide a clear description of the feature and how it improves the project.

### Submitting Code
- Keep your pull requests focused on a single change to make reviews easier.
- Follow the project’s code style.
- Ensure your code is properly tested before submitting.

### Commit Message Format
- Use meaningful and descriptive commit messages.
- Use the imperative mood (e.g., "Add feature" instead of "Added feature").

## Development Setup

To set up a local development environment:
1. Fork and clone the repository (as mentioned above).
2. Follow the installation steps in the README to get the project running locally.

---

Thank you for contributing to Retro! We appreciate your time and effort in helping us improve the project.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ To contribute to the Retro repository using GitHub Desktop, follow these steps:
<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Axe.png" width="20" height="20" >Submitting a fix<br>
<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Rocket.png" width="20" height="20" >Proposing new features

To get started with contributing, please follow the steps outlined in the [Contributing.md](Contributing.md).

<div align="center">
<h2 style="font-size:3rem;">Our Contributors <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="40" height="40" /></h2>
<h3>Thank you for contributing to our repository</h3>
Expand Down

0 comments on commit 875af02

Please sign in to comment.