Skip to content

Commit 5d97b39

Browse files
authored
Contributing flow - Updated README with CODE OF CONDUCT, License, Contributing, Added PR and Issue templates (#311)
Added Issue and PR Templates
1 parent 13fd2fa commit 5d97b39

File tree

5 files changed

+108
-2
lines changed

5 files changed

+108
-2
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve
4+
---
5+
6+
**Describe the bug**
7+
<!-- A clear and concise description of what the bug is. -->
8+
9+
**To Reproduce**
10+
Steps to reproduce the behavior:
11+
12+
<!-- Adding a codesandbox can help us understand the bug better and speed up things -->
13+
14+
**Expected behavior**
15+
<!-- A clear and concise description of what you expected to happen. -->
16+
17+
**Environment:**
18+
19+
- OS:
20+
- `@graphql-eslint/...`:
21+
- NodeJS:
22+
23+
**Additional context**
24+
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Have a question?
4+
url: https://github.com/dotansimha/graphql-eslint/discussions/new
5+
about: Not sure about something? need help from the community? have a question to our team? please ask and answer questions here.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for the core of this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
9+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
10+
11+
**Describe the solution you'd like**
12+
<!-- A clear and concise description of what you want to happen. -->
13+
14+
**Describe alternatives you've considered**
15+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
16+
17+
**Additional context**
18+
<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
🚨 **IMPORTANT: Please do not create a Pull Request without creating an issue first.**
2+
3+
*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*
4+
5+
## Description
6+
7+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
8+
9+
Fixes # (issue)
10+
11+
## Type of change
12+
13+
Please delete options that are not relevant.
14+
15+
- [ ] Bug fix (non-breaking change which fixes an issue)
16+
- [ ] New feature (non-breaking change which adds functionality)
17+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
18+
- [ ] This change requires a documentation update
19+
20+
## Screenshots/Sandbox (if appropriate/relevant):
21+
22+
Adding links to sandbox or providing screenshots can help us understand more about this PR and take action on it as appropriate
23+
24+
## How Has This Been Tested?
25+
26+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
27+
28+
- [ ] Test A
29+
- [ ] Test B
30+
31+
**Test Environment**:
32+
- OS:
33+
- `@graphql-eslint/...`:
34+
- NodeJS:
35+
36+
## Checklist:
37+
38+
- [ ] I have followed the [CONTRIBUTING](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md) doc and the style guidelines of this project
39+
- [ ] I have performed a self-review of my own code
40+
- [ ] I have commented my code, particularly in hard-to-understand areas
41+
- [ ] I have made corresponding changes to the documentation
42+
- [ ] My changes generate no new warnings
43+
- [ ] I have added tests that prove my fix is effective or that my feature works
44+
- [ ] New and existing unit tests and linter rules pass locally with my changes
45+
- [ ] Any dependent changes have been merged and published in downstream modules
46+
47+
## Further comments
48+
49+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,16 @@ You can find a complete list of [all available rules here](./docs/README.md)
171171

172172
If you wish to learn more about this project, how the parser works, how to add custom rules and more, [please refer to the docs directory](./docs/README.md))
173173

174-
## Contributing
174+
## Contributions
175175

176-
If you think a rule is missing, or can be modified, feel free to report issues, on open PRs. We always welcome contributions.
176+
Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!
177+
178+
And if this is your first time contributing to this project, please do read our [Contributor Workflow Guide](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md) before you get started off.
179+
180+
### Code of Conduct
181+
182+
Help us keep GraphQL ESLint open and inclusive. Please read and follow our [Code of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://www.contributor-covenant.org/)
183+
184+
## License
185+
186+
Released under the [MIT license](./LICENSE).

0 commit comments

Comments
 (0)