Skip to content

Commit d72b3e2

Browse files
committed
Update issue and PR templates
1 parent eb445b0 commit d72b3e2

File tree

3 files changed

+46
-26
lines changed

3 files changed

+46
-26
lines changed

.github/CONTRIBUTING.md

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
Contribution Guidelines
22
===
3+
34
> Project contribution guidelines.
45
56
When contributing to this project, please follow the provided guidelines.
67

8+
* Read and understood the style guides.
9+
* Read and understand the [Code of Conduct][code-of-conduct].
10+
* Read and understood the [licensing terms][license].
11+
712
===
13+
814
## Style Guides
915

1016
#### JavaScript
@@ -16,22 +22,22 @@ When contributing to this project, please follow the provided guidelines.
1622

1723
(...coming soon...)
1824

19-
* Google [style guide](https://google.github.io/styleguide/Rguide.xml)
20-
* Hadley's [notes](http://adv-r.had.co.nz/OO-essentials.html), which include a comment on `function` name conventions
25+
* Google [style guide](https://google.github.io/styleguide/Rguide.xml)
26+
* Hadley's [notes](http://adv-r.had.co.nz/OO-essentials.html), which include a comment on `function` name conventions
2127

2228

2329
#### Julia
2430

2531
(...coming soon...)
2632

27-
* Julia [style guide][julia-style-guide].
33+
* Julia [style guide][julia-style-guide].
2834

2935

3036
#### Python
3137

3238
(...coming soon...)
3339

34-
* [PEP 8](https://www.python.org/dev/peps/pep-0008/)
40+
* [PEP 8](https://www.python.org/dev/peps/pep-0008/)
3541

3642

3743
#### Go
@@ -43,23 +49,23 @@ When contributing to this project, please follow the provided guidelines.
4349

4450
(...coming soon...)
4551

46-
* [Core Guidelines](https://github.com/isocpp/CppCoreGuidelines)
47-
* [FAQ](http://www.stroustrup.com/bs_faq2.html)
48-
* [cppdoc](http://www.edparrish.net/common/cppdoc.html)
49-
* [cpm](https://github.com/iauns/cpm)
50-
- can also be used for C packages
52+
* [Core Guidelines](https://github.com/isocpp/CppCoreGuidelines)
53+
* [FAQ](http://www.stroustrup.com/bs_faq2.html)
54+
* [cppdoc](http://www.edparrish.net/common/cppdoc.html)
55+
* [cpm](https://github.com/iauns/cpm)
56+
- can also be used for C packages
5157

5258

5359
#### C
5460

5561
(...coming soon...)
5662

57-
* [clib](https://github.com/clibs/clib)
58-
* [package.json](https://github.com/clibs/clib/wiki/Explanation-of-package.json)
59-
* [packages](https://github.com/clibs/clib/wiki/Packages)
60-
* [list](https://github.com/clibs/list)
61-
* [levenshtein.c](https://github.com/wooorm/levenshtein.c)
62-
* [freebsd](https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9)
63+
* [clib](https://github.com/clibs/clib)
64+
* [package.json](https://github.com/clibs/clib/wiki/Explanation-of-package.json)
65+
* [packages](https://github.com/clibs/clib/wiki/Packages)
66+
* [list](https://github.com/clibs/list)
67+
* [levenshtein.c](https://github.com/wooorm/levenshtein.c)
68+
* [freebsd](https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9)
6369

6470

6571

@@ -74,23 +80,29 @@ When contributing to this project, please follow the provided guidelines.
7480

7581

7682
---
83+
7784
## Git
7885

79-
* All commits should follow the [seven rules][git-seven-rules] of a `git` commit message:
80-
- Use the [imperative mood][imperative-mood] in the `git` commit subject line.
81-
- Capitalize the first word of the subject line.
82-
- Do __not__ end the subject line with a period.
83-
- Separate the subject line from the body with a blank line.
84-
- Try to limit the subject line to `50` characters.
85-
- Use the body to explain the *what* and *why*, and not the *how*.
86-
- Try to wrap the body at `72` characters.
86+
* All commits should follow the [seven rules][git-seven-rules] of a `git` commit message:
87+
- Use the [imperative mood][imperative-mood] in the `git` commit subject line.
88+
- Capitalize the first word of the subject line.
89+
- Do __not__ end the subject line with a period.
90+
- Separate the subject line from the body with a blank line.
91+
- Try to limit the subject line to `50` characters.
92+
- Use the body to explain the *what* and *why*, and not the *how*.
93+
- Try to wrap the body at `72` characters.
8794

8895

8996

9097

9198
<!-- <links> -->
99+
100+
[code-of-conduct]: https://github.com/stdlib-js/stdlib/blob/master/.github/CODE_OF_CONDUCT.md
101+
[license]: https://github.com/stdlib-js/stdlib/blob/master/LICENSE
102+
92103
[git-seven-rules]: http://chris.beams.io/posts/git-commit/
93104
[imperative-mood]: https://en.wikipedia.org/wiki/Imperative_mood
94105

95106
[julia-style-guide]: http://docs.julialang.org/en/release-0.4/manual/style-guide/
107+
96108
<!-- </links> -->

.github/ISSUE_TEMPLATE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
> Please ensure the following tasks are completed before filing an issue.
55
6+
* [ ] Read and understood the [Code of Conduct][code-of-conduct].
67
* [ ] Searched for existing issues and pull requests.
78
* [ ] If this is a feature request, the issue name begins with `RFC: `.
89

@@ -86,4 +87,4 @@ The following environments are affected:
8687
* c
8788

8889

89-
90+
[code-of-conduct]: https://github.com/stdlib-js/stdlib/blob/master/.github/CODE_OF_CONDUCT.md

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ Resolves # .
44

55
> Please ensure the following tasks are completed before submitting this pull request.
66
7+
* [ ] Read, understood, and followed the [contributing guidelines][contributing], including the relevant style guides.
8+
* [ ] Read and understand the [Code of Conduct][code-of-conduct].
9+
* [ ] Read and understood the [licensing terms][license].
710
* [ ] Searched for existing issues and pull requests __before__ submitting this pull request.
811
* [ ] Filed an issue (or an issue already existed) __prior to__ submitting this pull request.
9-
* [ ] Read, understood, and followed the contributing guidelines, including the style guide.
10-
* [ ] Read and understood the licensing terms.
1112
* [ ] Rebased onto latest `develop`.
1213
* [ ] Submitted against `develop` branch.
1314

@@ -50,3 +51,9 @@ No.
5051
---
5152

5253
@stdlib-js/reviewers
54+
55+
56+
57+
[contributing]: https://github.com/stdlib-js/stdlib/blob/master/.github/CONTRIBUTING.md
58+
[code-of-conduct]: https://github.com/stdlib-js/stdlib/blob/master/.github/CODE_OF_CONDUCT.md
59+
[license]: https://github.com/stdlib-js/stdlib/blob/master/LICENSE

0 commit comments

Comments
 (0)