-
Notifications
You must be signed in to change notification settings - Fork 8
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.
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
Add CONTRIBUTING doc #4
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Contributing | ||
|
||
Thanks for your interest in contributing to Cookie Though! Please take a moment to review this document **before submitting a pull request**. | ||
|
||
## Pull requests | ||
|
||
**Please ask first before starting work on any significant new features.** | ||
|
||
It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create [an issue](https://github.com/inthepocket/cookie-though/issues) to first discuss any significant new features. This includes things like adding new utilities, creating new style rules, etc. | ||
|
||
## Coding standards | ||
|
||
Our code formatting rules are defined in [.eslintrc.js](https://github.com/inthepocket/cookie-though/blob/master/.eslintrc.js). You can check your code against these standards by running: | ||
|
||
```console | ||
npm run lint | ||
``` | ||
|
||
To automatically fix any style violations in your code, you can run: | ||
|
||
```console | ||
npm run lint -- --fix | ||
``` | ||
|
||
## Running tests | ||
|
||
You can run the test suite using the following commands: | ||
|
||
```console | ||
npm run test | ||
``` | ||
|
||
Please ensure that the tests are passing when submitting a pull request. If you're adding new features to Cookie Though, please include tests. We strive to have a coverage of at least 90% on this project. | ||
|
||
## Building the app and trying your changes locally | ||
|
||
In addition to the automated tests, if you'd like to test the app locally with your own app, you run the application by running: | ||
|
||
```console | ||
npm run dev | ||
``` | ||
|
||
This will create a running site in the `/dist` folder which you can view in your browser at [localhost:1234](localhost:1234). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that the correct language for console entries is console, not
sh
which means the sh shell specifically or sh scripts.