Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit feb66b5

Browse files
vinaypuppalvinaypuppal
committed
modify templates and add info about "Add yourself as a contributor"
1 parent 78e3874 commit feb66b5

File tree

4 files changed

+73
-24
lines changed

4 files changed

+73
-24
lines changed

‎.github/CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Coderplex web application comprises of two repositories :
2222
- [Sending a Pull Request](#sending-a-pull-request)
2323
- [Running Locally](#running-locally)
2424
- [Before submitting](#before-submitting)
25+
- [Add yourself as a contributor](#add-yourself-as-a-contributor)
26+
- [Submitting PullRequest](#submitting-pullrequest)
2527
- [After submitting](#after-submitting)
2628
- [Received a review request](#received-a-review-request)
2729
- [How to get in touch](#how-to-get-in-touch)
@@ -127,6 +129,21 @@ We welcome pull requests from beginners and seasoned javaScript developers alike
127129
yarn lint
128130
```
129131
1. Add and commit your code. Please give meaning full commit messages.
132+
133+
#### Add yourself as a contributor
134+
135+
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
136+
137+
To add yourself to the table of contributors on the `README.md`, please use the automated script as part of your PR:
138+
139+
```bash
140+
yarn run add-contributor
141+
```
142+
143+
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
144+
145+
#### Submitting PullRequest
146+
130147
1. Pull latest code from [upstream repository's](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`develop`, if in case anything new were merged while you were working on your fork.
131148
1. Push the code to your fork.
132149
1. Raise the pull request from your created branch to `develop` branch of coderplex. [why develop instead of master branch?](https://www.atlassian.com/git/tutorials/comparing-workflows)

‎.github/ISSUE_TEMPLATE.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,36 @@
66
-->
77

88
<!-- Checked checkbox should look like this: [x] -->
9-
- [ ] I have searched the [issues](https://github.com/coderplex/coderplex/issues) of this repository and believe that this is not a duplicate.
109

11-
## Expected Behavior
10+
* [ ] I have searched the [issues](https://github.com/coderplex/coderplex/issues) of this repository and believe that this is not a duplicate.
11+
12+
# Expected Behavior
13+
1214
<!--- If you're describing a bug, tell us what should happen -->
15+
1316
<!--- If you're suggesting a change/improvement, tell us how it should work -->
1417

15-
## Current Behavior
18+
# Current Behavior
19+
1620
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
21+
1722
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
1823

1924
## Steps to Reproduce (for bugs)
25+
2026
<!--- Provide unambiguous set of steps to -->
27+
2128
<!--- reproduce this bug. Include screenshot, if relevant -->
22-
1.
23-
2.
24-
3.
25-
4.
29+
30+
1. <!-- Step 1 -->
31+
1. <!-- Step 2 -->
2632

2733
## Your Environment
34+
2835
<!--- Include as many relevant details about the environment you experienced the bug in -->
36+
2937
| Tech | Version |
30-
|---------|---------|
38+
| ------- | ------- |
3139
| OS | |
3240
| browser | |
3341
| etc | |

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,45 @@
1-
<!--- Provide a general summary of the PR in the Title above -->
2-
31
<!--
42
Thank you very much for contributing to coderplex by creating an PR! ❤️
5-
To quickly merge this PR we ask you to check off the following list
63
-->
74

8-
<!--place the issue number which this PR is solving. Eg: Fixes #27-->
9-
Fixes
5+
<!--
6+
Please make sure you are familiar with and follow the instructions in the
7+
contributing guidelines (found in the CONTRIBUTING.md file).
8+
9+
Please fill out the information below to expedite the review and (hopefully)
10+
merge of your pull request!
11+
-->
12+
13+
<!-- Is it a Bug fix, feature, docs update, ... -->
14+
15+
# What kind of change does this PR introduce
16+
17+
<!-- You can also link to an open issue here -->
1018

11-
## Changes proposed in this PR
12-
- <!-- change 1-->
13-
- <!--change 2-->
19+
## What is the current behavior
20+
21+
<!-- if this is a feature change -->
22+
23+
## What is the new behavior
24+
25+
<!-- Have you done all of these things? -->
1426

15-
<!-- Checked checkbox should look like this: [x] -->
1627
### Checklist for this PR
1728

18-
- [ ] I have read [contributing guidelines](https://github.com/coderplex/coderplex/blob/develop/.github/CONTRIBUTING.md).
19-
- [ ] I executed `yarn lint` locally to format my code.
20-
- [ ] All tests `yarn test` ran successfully.
21-
- [ ] Pull request is towards `develop` branch.
22-
<!--If change is related to UI then tick below checkbox otherwise delete below line-->
23-
- [ ] I have tested responsiveness of the UI by checking on max devices using [ScreenFly](http://quirktools.com/screenfly/)
29+
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
30+
31+
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
32+
33+
* [ ] I have read [contributing guidelines](https://github.com/coderplex/coderplex/blob/develop/.github/CONTRIBUTING.md).
34+
* [ ] I executed `yarn lint` locally to format my code.
35+
* [ ] All tests `yarn test` ran successfully.
36+
* [ ] Pull request is towards `develop` branch.
37+
* [ ] I have tested responsiveness of the UI by checking on devices using [ScreenFly](http://quirktools.com/screenfly/) <!--If change is related to UI then tick this checkbox otherwise mention N/A-->
38+
* [ ] Documentation
39+
* [ ] Tests
40+
* [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
41+
* [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions -->
42+
43+
<!-- feel free to add additional comments -->
44+
45+
<!-- Thank you for contributing! -->

‎.markdownlint.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
{
22
"line-length": false,
3-
"ul-style": false
3+
"ul-style": false,
4+
"no-inline-html": false,
5+
"first-line-h1": false
46
}

0 commit comments

Comments
 (0)