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

Contribution steps are updated in the readme file #74

Merged
merged 1 commit into from
Mar 3, 2023
Merged
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
Contribution steps are added
  • Loading branch information
itsshahinhere committed Mar 2, 2023
commit fa291e1f4358ad420b28b0c5d581b6e1ce6ccfe4
71 changes: 64 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,76 @@ Also we have been focussing on the women health and hygiene so that they donot f
**We're accepting PRs for our open and unassigned [issues](https://github.com/nisha331/flow_cycle1/issues)**.


**1.** Fork [this](https://github.com/nisha331/flow_cycle1) repository.
### Steps to Contribute

**2.** Clone the forked repository.
Following are the steps to Contribute:

**3.** Navigate to the project directory.
* Step 1: Fork [this repo](https://github.com/nisha331/flow_cycle1)

* Step 2: Clone the forked copy of the project to your machine:

**4.** Make changes in source code.
```
https://github.com/<your github user name>/flow_cycle1.git
```

**5.** Stage your changes and commit
* Step3: Navigate to the project directory.

**6.** Push your local commits to the remote repo.
```
cd flow_cycle1
```

**7.** Create a [PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) to `develop` !) repository.
* Step 4: Add the original (upstream) repo reference to your project (origin)

```
git remote add upstream https://github.com/nisha331/flow_cycle1.git
```

* Step 5: Check the repo url attached to your project

```
git remote -v
```

* Step 6: To keep your repo (origin) updated, always pull the updates from the main of the original repo (upstream)

```
git pull upstream main
```

* Step 7: Create a new branch (Never update any changes to the main of the upstream repo)

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

* Step 8: Make the necessary changes and commit those changes to the branch you created

* Step 9: Add those changes to your repo:

```
git add.
```

* Step 10: Commit those changes with a message of whats changed:

```
git commit -m "Your message blah blah"
```

* Step 11: Push those commited changes in your feature branch to your remote repo (origin):

```
git push -u origin <the branch name of your created and made changes>
```

* Step 12: Create a pull request, click on 'compare & pull request'.
Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to (usually the main branch of the upstream).

* Step 13: Name a appropriate title and description of the changed you made to your pull request.

* Step 14: click on 'Create pull request'.

* Step 15: Congratulation! you have done creating a pull request to this project. Be patient while your PR is reviewed. Note that if you made any changed to the branch (to which you created a pull request), github will automatically update those changes to the pull request after you pushed those changed to the remote repo (origin).

## Project Admin

Expand Down