Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(checklist): Add code sample for Tonic REPL #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(checklist): Add code sample for Tonic REPL #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Use [save-exact](https://docs.npmjs.com/misc/config#save-exact) NPM setting and
or [fixpack](https://github.com/henrikjoreteg/fixpack)
- [ ] write simple installation commands for your module
- [ ] write "quick intro" example showing the main feature of your module
- [ ] include the code example in your `package.json` so it shows on when a user is testing your module on [Tonic](https://tonicdev.uservoice.com/knowledgebase/articles/765846-how-do-i-customize-the-example-for-my-npm-package)
- [ ] add CONTRIBUTING.md file with clear guidelines how others can add new features or fix bugs
in your module. [Atom editor](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) and [lodash](https://github.com/lodash/lodash/blob/master/CONTRIBUTING.md) have excellent examples to follow.
When GitHub finds a CONTRIBUTING.md file it [shows a message](https://github.com/blog/1184-contributing-guidelines) to anyone opening an issue.
Expand Down