Skip to content

Commit

Permalink
add resources
Browse files Browse the repository at this point in the history
  • Loading branch information
satyampgt4 committed Oct 15, 2021
1 parent 07ad309 commit ee4c9df
Showing 1 changed file with 30 additions and 11 deletions.
41 changes: 30 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,49 +32,68 @@ git remote add upstream https://github.com/vj-abigo/invite-on-label.git
```
git remote -v
```

**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
**6.**To setup the environment in your system run the following commands
```
npm install
```
**7.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

```
git pull upstream main
```

**7.** Create a new branch.
**8.** Create a new branch.

```
git checkout -b <your_branch_name>
```

**8.** Perform your desired changes to the code base.
**9.** Perform your desired changes to the code base.

<p align="center"><img width=35% src="https://media2.giphy.com/media/L1R1tvI9svkIWwpVYr/giphy.gif?cid=ecf05e47pzi2rpig0vc8pjusra8hiai1b91zgiywvbubu9vu&rid=giphy.gif"></p>

**9.** add your changes:heavy_check_mark: .
**10.** After when you made your necessary changes. Build the file using
```
npm run build
```
**11.** add your changes:heavy_check_mark: .

```
git add .
```

**10.** Commit your changes .
**12.** Commit your changes .

```
git commit -m "Relevant message"
```

**11.** Push the committed changes in your feature branch to your remote repo.
**13.** Push the committed changes in your feature branch to your remote repo.

```
git push origin <your_branch_name>
```
**12.** Go to your fork you will a popup saying "Compare & Pull Request"
**14.** Go to your fork you will a popup saying "Compare & Pull Request"

![compare&pull](https://user-images.githubusercontent.com/43697446/134040805-c114ccf9-aa14-427e-b01f-8dcb2f58ef94.png)

**13.** To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repo you are supposed to make a PR to.
**15.** To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repo you are supposed to make a PR to.


**14.** Add an appropriate title and description to your pull request explaining your changes and efforts done and click on make a PR.
**16.** Add an appropriate title and description to your pull request explaining your changes and efforts done and click on make a PR.

**15.** Wait for the reviewers to approve and merge it.
**17.** Wait for the reviewers to approve and merge it.

### And that's it, you're done! We're looking forward to having wonderful contributors with us
----------------------------------------------------------------------------------------

## Resources that might be helpful


Docs on creating a GitHub action: https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action

Docs on octokit: https://octokit.github.io/rest.js/v18

Docs for GitHub workflow: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions

Docs for workflow events: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#issues

0 comments on commit ee4c9df

Please sign in to comment.