Skip to content
Permalink
Browse files

Update Contributing+Templates

  • Loading branch information...
evanplaice committed May 7, 2019
1 parent 4ac3782 commit 0f82f121681cc4d68d2c5e80b4666697e2202fa0
@@ -30,5 +30,5 @@ Tell us what happens instead

- [name](href)

[Feature]: https://github.com/evanplaice/jquery-csv/issues/new?template=FEAT_TEMPLATE.md&title=feat()&labels=feature
[Feature]: https://github.com/typeiii/jquery-csv/issues/new?template=FEAT_TEMPLATE.md&labels=feature
[StackOverflow]: https://stackoverflow.com/questions/tagged/jquery-csv?mixed=1
@@ -9,23 +9,17 @@ A brief description of what the feature aims to accomplish

## Checklist

- [ ] Is this API breaking?
- [ ] Is this tested?
- [ ] Is documentation required?
- [ ] Will you be taking ownership of this change?

*Note: Don't worry about leaving these unchecked. These exist to quickly identify common requirements.*
- [ ] Is documentation up-to-date?

## Details

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.
<!-- 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. -->

## References

- [name](href)

When this feature is ready to move on to implementation, create a [Specification][Specification].

*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.*
<!-- When this feature is ready to move on to implementation, create a [Specification][Specification]. -->

[Specification]: https://github.com/evanplaice/jquery-csv/issues/new?template=SPEC_TEMPLATE.md&title=spec()&labels=specification
[Specification]: https://github.com/typeiii/jquery-csv/issues/new?template=SPEC_TEMPLATE.md&labels=specification
@@ -19,5 +19,3 @@ Add code snippets and/or a more in-depth description of the implementation detai
## References

- [name](href)

*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.*
@@ -1,12 +1,9 @@
If you don't know where to start, take a look at the [Roadmap][Roadmap] of proposed changes for the next release.

# How You Can Help

## Non-code contributions

- If you'd like to edit/update the documentation, submit a Pull Request
- If you'd like to start a dialog, post a new [Discussion][Discussion]
- If you'd like to mention a project where jquery is used, post a comment in the [Mentions][Mentions]
- If you'd like to assist other users of jquery-csv, answer qustions on [StackOverflow][StackOverflow]
- If you'd like to promote this project, write articles or blog posts and link back to the project

@@ -37,10 +34,8 @@ If you don't know where to start, take a look at the [Roadmap][Roadmap] of propo
- Make superficial changes (ie style/structure) to existing code
- Make API breaking changes unless they're clearly documented in a Specification

[Roadmap]: https://github.com/evanplaice/jquery-csv/issues/92
[Discussion]: https://github.com/evanplaice/jquery-csv/issues/new?template=DISC_TEMPLATE.md&title=disc()&labels=discussion
[Mentions]: https://github.com/evanplaice/jquery-csv/issues/97
[Discussion]: https://github.com/typeiii/jquery-csv/issues/new?template=DISC_TEMPLATE.md&labels=discussion
[StackOverflow]: https://stackoverflow.com/questions/tagged/jquery-csv?mixed=1
[Feature]: https://github.com/evanplaice/jquery-csv/issues/new?template=FEAT_TEMPLATE.md&title=feat()&labels=feature
[Specification]: https://github.com/evanplaice/jquery-csv/issues/new?template=SPEC_TEMPLATE.md&title=spec()&labels=specification
[Feature]: https://github.com/typeiii/jquery-csv/issues/new?template=FEAT_TEMPLATE.md&labels=feature
[Specification]: https://github.com/typeiii/jquery-csv/issues/new?template=SPEC_TEMPLATE.md&labels=specification
[Forking Workflow]: https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow

0 comments on commit 0f82f12

Please sign in to comment.
You can’t perform that action at this time.