Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iampavangandhi authored Sep 3, 2020
1 parent 8151724 commit feaf86e
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# CONTRIBUTING

This is a group project started under The Uplift Project (Nodejs Stack) by GS Foundation. But It's open for contribution from everyone.

Kindly write a proper description while making issues or pull requests.

## Ways of Contributing

### You can contribute in many ways:

1. By adding features
2. By reporting bugs
3. By solving issues
4. By improving the code quality
5. By improving the readme and docs

## Contributing Guidelines

### The basic guidelines for contributing are as follows:

- Fork the repo
- Clone the repo
- Create a branch using
- `git checkout -b fix/#issuenumber`
or
- `git checkout -b bug/feature`
- Fix Issue / Add Feature / Solve Bug / Do Coding
- Test the changes in your system
- Create a pull request using below commands
- `git add --all`
- `git commit -m "your commit message"`
- `git push origin branch-name`
- Go to the [Repository](https://github.com/iampavangandhi/TradeByte)
- Create Pull Request against `master` branch
- Add a suitable title and description to the Pull Request, `Add TradeByte Project in Projects`, and `Tag the Issue number in Pull Request description` if the pull request is related to some issue logged here: [Issues](https://github.com/iampavangandhi/TheNodeCourse/issues)
- You're done. Wait for your code to get reviewed and merged

### Give it a Star 🌟 if you like our Work 😊

0 comments on commit feaf86e

Please sign in to comment.