Skip to content

Commit eba815d

Browse files
authored
chore(github): add github templates (#50)
1 parent 2166a43 commit eba815d

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

.github/CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing to this Project
2+
3+
Thank you for your interest. `eslint-config-fullstack` generally conforms to the following principles:
4+
5+
* Configuring rules
6+
* Maintain a list of every base ESLint rule & every `eslint-plugin-react` rule. This means tracking changes to those packages, which [Greenkeeper](https://greenkeeper.io/) helps with.
7+
* When a new version of those deps is published, read the changelog and add / modify the relevant rules in the corresponding Greenkeeper branch. **Do not** simply merge the GK branch as-is.
8+
* When simply turning rules off, set them to `0`, do not delete them
9+
* Delete deprecated rules only
10+
* Keep the rule summary, verbatim from the corresponding API reference, as a comment following the rule
11+
* Activate rules whose pedagogical and/or stylistic value outweighs their annoyance
12+
* If a rule *almost definitely* indicates broken code, set it to `2` (error)
13+
* If a rule *quite possibly* flags code that could still work, set it to `1` (warning)
14+
* Code style
15+
* This repo uses [Prettier](https://prettier.io/) and [lint-staged](https://github.com/okonet/lint-staged) to automatically maintain formatting.
16+
* If you prefer, you can run Prettier yourself on the code to preview how it will be auto-formatted, using `npm run prettify` or activating an [editor plugin](https://prettier.io/docs/en/editors.html)
17+
* Respect [SEMVER](https://semver.org/) when publishing to npm
18+
* Turning rules off will count as a minor change as nobody's code should break (in theory)
19+
* Turning rules on or changing their options should count as a major change as linting may now result in nonzero exit codes where none existed before

.github/ISSUE_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
For bugs, please include the following:
2+
3+
* What is the expected behavior?
4+
* What is the actual behavior?
5+
* What steps reproduce the behavior?
6+
7+
---
8+
9+
*Issue description here…*

.github/PULL_REQUEST_TEMPLATE.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Assignee Tasks
2+
3+
Please check all that apply.
4+
5+
- [ ] referenced any relevant issue(s)
6+
- [ ] Adding new rule(s)?
7+
- [ ] Included rule summary verbatim from docs as a comment
8+
- [ ] Placed in the right section (stylistic / node / etc.), in alphabetical order
9+
- [ ] Set to `0` (off), `1` (warn), or `2` (error) as spec'd in contributing guidelines
10+
- [ ] Changing active rule(s) severity?
11+
- [ ] Set to `1` (warn), or `2` (error) as spec'd in contributing guidelines
12+
- [ ] Removing rule(s)?
13+
- [ ] Set to `0` if disabling, or delete _only if deprecated_
14+
15+
---
16+
17+
*Your PR Notes Here*

0 commit comments

Comments
 (0)