forked from EddieHubCommunity/BioDrop
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: adding contributing.md (EddieHubCommunity#32)
- Loading branch information
Showing
1 changed file
with
80 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
## 💥 How to Contribute | ||
|
||
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) | ||
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/) | ||
|
||
- Take a look at the Existing [Issues](https://github.com/EddieHubCommunity/Members/issues) or create your own Issues! | ||
- Fork the Repo and create a Branch for any Issue that you are working upon. | ||
- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it. | ||
- Add Screenshots to help us know what this Script is all about. | ||
|
||
|
||
## ⭐HOW TO MAKE A PULL REQUEST: | ||
|
||
**1.** Fork [this](https://github.com/EddieHubCommunity/Members) repository. | ||
Click on the <a href="https://github.com/EddieHubCommunity/Members"><img src="https://img.icons8.com/ios/24/000000/code-fork.png"></a> symbol at the top right corner. | ||
|
||
**2.** Clone the forked repository. | ||
|
||
```bash | ||
git clone https://github.com/<your-github-username>/Members | ||
``` | ||
|
||
**3.** Navigate to the project directory. | ||
|
||
```bash | ||
cd Members | ||
``` | ||
**5.** Create a new branch: | ||
```bash | ||
git checkout -b YourBranchName | ||
``` | ||
|
||
**6.** Make changes in source code. | ||
|
||
**7.** Stage your changes and commit | ||
|
||
```bash | ||
git add . | ||
``` | ||
```bash | ||
git commit -m "<your_commit_message>" | ||
``` | ||
|
||
**8.** Push your local commits to the remote repo. | ||
|
||
```bash | ||
git push origin YourBranchName | ||
``` | ||
|
||
**8.** Create a [PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) ! | ||
|
||
**9.** **Congratulations!** Sit and relax, you've made your contribution to [Members](https://github.com/EddieHubCommunity/Members) project. | ||
|
||
***:trophy: After this, project leaders and mentors will review the changes and will merge your PR if they are found good, otherwise we will suggest the required changes.*** | ||
|
||
## Style Guides for Git Commit Messages:memo: | ||
|
||
#### Here's a list of some good to have points, that can add more value to your contribution logs. | ||
|
||
- Use the present tense (example: "Add feature" and not "Added feature") | ||
- Use the imperative mood (example: "Move item to...", instead of "Moves item to...") | ||
- Limit the first line (also called subject line) to 50 characters or less | ||
- Capitalize the subject line | ||
- Separate subject from body with a blank line | ||
- Do not end the subject line with a period | ||
- Wrap the body at 72 characters | ||
- Use the body to explain what, why, vs, and how | ||
- Reference issues and pull requests liberally after the first line | ||
|
||
|
||
## 💥 Issues: | ||
For major changes, you are welcomed to open an issue about what you would like to contribute. Enhancements will be appreciated. | ||
|
||
#### All the Best!🥇 | ||
|
||
<p align = "center"> | ||
|
||
[![built with love](https://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/unnati914/Care4ther-) | ||
|
||
</p> |