Add CONTRIBUTING.md to solicit contributions #846
Conversation
Codecov Report
@@ Coverage Diff @@
## main #846 +/- ##
=======================================
Coverage 99.25% 99.25%
=======================================
Files 98 99 +1
Lines 1474 1476 +2
Branches 482 482
=======================================
+ Hits 1463 1465 +2
Misses 11 11
Continue to review full report at Codecov.
|
CONTRIBUTING.md
Outdated
|
|
||
| #### Resolving existing issues | ||
|
|
||
| You can consider helping out with [issues](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/issues) already requiring attention. |
There was a problem hiding this comment.
should this link to the "help wanted" label?
CONTRIBUTING.md
Outdated
|
|
||
| > **Note:** Before submitting an issue, please check open and closed issues to see if the problem has already been reported. | ||
|
|
||
| If you want to propose a new rule, please follow these [instructions](https://eslint.org/docs/developer-guide/contributing/new-rules). |
There was a problem hiding this comment.
these are eslint core's guidelines - probably worth folks reading, but not necessarily the criteria we'd apply here.
There was a problem hiding this comment.
thank you for letting me know, I removed this sentenceπ
CONTRIBUTING.md
Outdated
| * `fix` for a bug fix | ||
| * `feat` either for a backwards-compatible enhancement or for a rule change that adds reported problems | ||
| * `fix!` for a backwards-incompatible bug fix | ||
| * `feat!` for a backwards-incompatible enhancement or feature | ||
| * `docs` for changes to documentation only | ||
| * `chore` for changes that aren't user-facing | ||
| * `build` for changes to build process only | ||
| * `refactor` a change that doesn't affect APIs or user experience | ||
| * `test` just changes to test files | ||
| * `ci` changes to our CI configuration files and scripts | ||
| * `perf` a code change that improves performance |
There was a problem hiding this comment.
these are angular's/conventional-commit's commit message conventions, and i don't use them. in particular, i'm philosophically opposed to "chore" - chores are bad, repo maintenance is good.
my commit conventions are undocumented but somewhat consistent. i suppose i should probably document them in a gist, and then we can link to that here.
There was a problem hiding this comment.
I've seen those listed on the ESLint website, this is why I've included them hereπ. Will remove them for now and wait for your gist.
CONTRIBUTING.md
Outdated
|
|
||
| ## Code of Conduct | ||
|
|
||
| We adhere to the [OpenJS Foundation Code of Conduct](https://github.com/openjs-foundation/cross-project-council/blob/main/CODE_OF_CONDUCT.md) and expect |
There was a problem hiding this comment.
this is a great idea, but we don't actually adhere to that in this github org yet. we could add a CODE_OF_CONDUCT.md file to https://github.com/jsx-eslint/.github, though, and then we don't need to mention it here at all.
There was a problem hiding this comment.
I din't know - I've taken this reference from the ESLlint website, will remove it, thank you for pointing it out π
uncommon-type
force-pushed
the
add-contributor-guidelines
branch
from
b53f428
to
3877002
Compare
|
This is pending jsx-eslint/.github#1. |
uncommon-type
force-pushed
the
add-contributor-guidelines
branch
3 times, most recently
from
b7d1e58
to
cfbb069
Compare
ljharb
force-pushed
the
add-contributor-guidelines
branch
from
cfbb069
to
ee933a2
Compare
Description
This PR adds a
CONTRIBUTING.mdfile to provide potential contributors with a short guide on how to help with the project. It explains the ways to get involved as well as gives setup/installation details and information on how to submit Pull Requests.Related Issue
Closes #845
Acceptance Criteria
Type of Changes