Skip to content

Commit d34e87c

Browse files
evanplaiceevanplaice
committed
Make jquery-csv contributor friendly
Update docs and add issue/PR templates to assist this process
1 parent a954448 commit d34e87c

File tree

6 files changed

+164
-23
lines changed

6 files changed

+164
-23
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Is this a bug? If not consider asking on [StackOverflow][StackOverflow].
2+
3+
Does the documentation require improvement? Consider posting a [Feature][Feature] with the the recommended changes.
4+
5+
# Subject of the issue
6+
7+
Provide a brief description of your issue.
8+
9+
## Environment
10+
11+
- Platform: Node | Browser
12+
- Version: Chrome 50
13+
- Usage: Load from file | Load from Ajax | Hooks
14+
15+
## Steps to reproduce
16+
17+
- step1
18+
- step2
19+
- step3
20+
21+
## Expected behaviour
22+
23+
Tell us what should happen
24+
25+
## Actual behaviour
26+
27+
Tell us what happens instead
28+
29+
## References
30+
31+
- [name](href)
32+
33+
[Feature]: https://github.com/evanplaice/jquery-csv/issues/new?template=FEAT_TEMPLATE.md&title=feat()&labels=feature
34+
[StackOverflow]: https://stackoverflow.com/questions/tagged/jquery-csv?mixed=1

‎.github/ISSUE_TEMPLATES/DISC_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Topic
2+
3+
## What Does this Impact?
4+
5+
Write a brief description of how this discussion applies to jquery-csv.
6+
7+
## Notes
8+
9+
Optionally, compile notes from the discussion here.
10+
11+
## References
12+
13+
- [link](href)

‎.github/ISSUE_TEMPLATES/FEAT_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# the name of the feature
2+
3+
A brief description of what the feature aims to accomplish
4+
5+
## Goals
6+
7+
- goal
8+
- goal
9+
10+
## Checklist
11+
12+
- [ ] Is this API breaking?
13+
- [ ] Is this tested?
14+
- [ ] Is documentation required?
15+
- [ ] Will you be taking ownership of this change?
16+
17+
*Note: Don't worry about leaving these unchecked. These exist to quickly identify common requirements.*
18+
19+
## Details
20+
21+
Add a loose outline. Don't worry about implementation specifics yet. Feature requests are intended to start a dialog. If this is good to move forward, a specification will be created to outline the implementation details.
22+
23+
## References
24+
25+
- [name](href)
26+
27+
When this feature is ready to move on to implementation, create a [Specification][Specification].
28+
29+
*Note: If you're confused and need help getting started, ask lots of questions in the comments. Your contributions are appreciated and your effort is welcome, even if that requires discussing development practices that fall outside the scope of this project.*
30+
31+
[Specification]: https://github.com/evanplaice/jquery-csv/issues/new?template=SPEC_TEMPLATE.md&title=spec()&labels=specification

‎.github/ISSUE_TEMPLATES/SPEC_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# the name of the specification
2+
3+
A brief description of the specification
4+
5+
## Goals
6+
7+
- goal
8+
- goal
9+
10+
## Milestones
11+
12+
- [ ] milestone
13+
- [ ] milestone
14+
15+
## Details
16+
17+
Add code snippets and/or a more in-depth description of the implementation details
18+
19+
## References
20+
21+
- [name](href)
22+
23+
*Note: If you're confused and need help getting started, ask lots of questions in the comments. Your contributions are appreciated and your effort is welcome, even if that requires discussing development practices that fall outside the scope of this project.*

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
If this PR applies to an existing spec, link to it and delete the rest.
2+
3+
## Checklist
4+
5+
- [ ] Is this API breaking?
6+
- [ ] Is this tested?
7+
- [ ] Is Documentation required?
8+
9+
*Note: Don't worry about leaving these unchecked. These exist to quickly identify common requirements.*
10+
11+
## Description
12+
13+
Post a brief description of the changes.
14+
15+
## References
16+
17+
- [name](href)

‎CONTRIBUTING.md

Lines changed: 46 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,46 @@
1-
## Long-Term Development
2-
3-
1.0 will be the first long-term stable release. The API will be locked until the next major release. New functionality-breaking and/or backwards incompatible changes will be introduced into the master branch.
4-
5-
## Short-Term Development
6-
7-
0.8.0 The first stable release following the migration to GitHub from Google Code.
8-
9-
* The parser is fully featured and mostly bug free
10-
* The TODO list includes re-vamping of the Documentation & examples
11-
* Tests will be revisited and work will be done to add headless browser testing support.
12-
* NPM support will be added
13-
* Hopefully, Bower support can be transferred over from Mirlord and updated to the latest.
14-
15-
## How You Can Help
16-
17-
**Run the test runner:** Just run the **tests** in your particular brand of browser and report any failures.
18-
19-
**We need performance tests:** Performance tests in javascript would add a lot of value to the project. If that's your forte, don't be shy.
20-
21-
**Provide feedback:** If you have a good suggestion, a useful use case, or just want to share your experience, don't hesitate to get involved.
22-
23-
Without your contributions and the contributions of the community, this would be just another half-baked CSV to add to the pile of literally thousands of broken/incomplete implementations. The quality of projects like these is a direct result of a greater community that is willing to suggest improvements and test the code.
1+
If you don't know where to start, take a look at the [Roadmap][Roadmap] of proposed changes for the next release.
2+
3+
# How You Can Help
4+
5+
## Non-code contributions
6+
7+
- If you'd like to edit/update the documentation, submit a Pull Request
8+
- If you'd like to start a dialog, post a new [Discussion][Discussion]
9+
- If you'd like to mention a project where jquery is used, post a comment in the [Mentions][Mentions]
10+
- If you'd like to assist other users of jquery-csv, answer qustions on [StackOverflow][StackOverflow]
11+
- If you'd like to promote this project, write articles or blog posts and link back to the project
12+
13+
## Code Contributions
14+
15+
- If you'd like to add a new example or test, submit a [Specification][Specification]
16+
- If you'd like to propose a new feature, submit a [Feature][Feature] request
17+
18+
**DO**
19+
20+
- Follow the [Forking Workflow][Forking Workflow]
21+
1. Fork the project
22+
2. Clone your fork
23+
3. Add a remote to the main project
24+
3. Create a new `feature` branch
25+
4. Checkout the `feature` branch
26+
5. Commit your changes
27+
6. Rebase your changes onto the latest
28+
7. Post a PR comparing `master` to the `feature` branch on your fork
29+
- Provide tests where applicable
30+
- Provide documentation updates that apply to the changes
31+
- Follow the current style of the project
32+
33+
**Don't**
34+
35+
- Group multiple features into a single PR
36+
- Co-mingle whitespace changes with code changes
37+
- Make superficial changes (ie style/structure) to existing code
38+
- Make API breaking changes unless they're clearly documented in a Specification
39+
40+
[Roadmap]: https://github.com/evanplaice/jquery-csv/issues/92
41+
[Discussion]: https://github.com/evanplaice/jquery-csv/issues/new?template=DISC_TEMPLATE.md&title=disc()&labels=discussion
42+
[Mentions]: https://github.com/evanplaice/jquery-csv/issues/97
43+
[StackOverflow]: https://stackoverflow.com/questions/tagged/jquery-csv?mixed=1
44+
[Feature]: https://github.com/evanplaice/jquery-csv/issues/new?template=FEAT_TEMPLATE.md&title=feat()&labels=feature
45+
[Specification]: https://github.com/evanplaice/jquery-csv/issues/new?template=SPEC_TEMPLATE.md&title=spec()&labels=specification
46+
[Forking Workflow]: https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow

0 commit comments

Comments
 (0)