Skip to content

Commit

Permalink
Added contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MonalikaPatnaik committed Dec 9, 2023
1 parent 39c147c commit c5506f7
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
### πŸ§‘β€πŸ’» Contribution Guidelines

## Introduction
We deeply value your enthusiasm for enhancing this project! We warmly welcome your valuable contributions and invite you to participate in elevating it to new heights.

## Getting Started
There are some steps that you need to follow before making any contribution in this project, the following steps are important to get start.


### Step 1. Fork the Repository
[Fork](https://github.com/MonalikaPatnaik/SheEARNS/fork) the repo first

### Step 2. Clone the forked Repository
```
git clone https://github.com/<your_github_username>/SheEARNS.git
```
### Step 3. Set Up Remotes
- Add a reference (remote) to the original repository:
```
git remote add upstream https://github.com/MonalikaPatnaik/SheEARNS.git
```
- Add a reference (remote) to your forked repository:
```
git remote add origin https://github.com/<your_user_name>/SheEARNS.git
```
### Step 4. Check Remotes
```
git remote -v
```
### Step 5. Keep Your Local Copy Updated
```
git pull upstream main
```
### Step 6. Create a New Branch
```
git checkout -b <your_branch_name>
```
## Making Changes
Perform your desired changes to the code base.
### Step 7. Track Changes
```
# Track the changes
git status
# Add changes to Index
git add . or git add <file_name>
```
### Step 8. Commit Changes
```
git commit -m "Write a meaningful but small commit message"
```
### Step 9. Push Changes
```
git push -u origin <your_branch_name>
```
### 10. Compare and Create
- Click on "Compare And Pull Requests" πŸ”„
- Make sure your pull request adheres to our contribution guidelines. Pull requests that do not meet the guidelines may be closed or discarded ❌
- Add an appropriate title and description to your pull request, explaining your changes with suitable explanations and screenshots πŸ“πŸ–ΌοΈ
- Click on "Create Pull Request" to submit your contribution for review βœ…
We appreciate your understanding and cooperation in following our guidelines. Thank you for your contribution! πŸ™Œ
Congratulations! You've made your PR with the desired changes. Once the PR is reviewed, it will be merged into the original codebase for everyone to see and use.
## Thank You!
Thank you so much for contributing. We appreciate your valuable input, and we hope to see you again soon. 😊

0 comments on commit c5506f7

Please sign in to comment.