forked from KartikTalwar/gmail.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contributor guidelines mentioning code-linting
- Loading branch information
Showing
2 changed files
with
51 additions
and
1 deletion.
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,47 @@ | ||
|
||
# Contributing to gmail.js | ||
|
||
## Documentation | ||
|
||
If you introduce new API calls or features, please ensure they are | ||
documented. Having it both in the `README.md`-file and as code-doc | ||
makes it easier to use for everyone! | ||
|
||
## Code quality | ||
|
||
Gmail.js tries to keep a consistent code-quality and style-guide. | ||
|
||
To enforce this, `eslint` is used. | ||
|
||
Before submitting any patches, please run check that you have not | ||
increased the amount of warnings, or caused any linting-errors. You | ||
can do this by running `npm run lint`: | ||
|
||
````bash | ||
$ npm install | ||
$ npm run lint | ||
|
||
> [email protected] test /home/jostein/build/gmail.js | ||
> eslint src/*.js | ||
|
||
|
||
/home/jostein/build/gmail.js/src/gmail.js | ||
650:66 warning 'j' is defined but never used no-unused-vars | ||
691:48 warning 'xhr' is defined but never used no-unused-vars | ||
942:85 warning 'password' is defined but never used no-unused-vars | ||
1086:44 warning 'response' is defined but never used no-unused-vars | ||
1122:65 warning 'callbacks' is defined but never used no-unused-vars | ||
1442:86 warning 'sub' is defined but never used no-unused-vars | ||
|
||
✖ 6 problems (0 errors, 6 warnings) | ||
|
||
```` | ||
|
||
Submissions with actual linting-errors will not be accepted, and | ||
linting-warnings should be taken as that: Your code may not be doing | ||
what you think it does. | ||
|
||
## Anything else? | ||
|
||
Apart from that: Feel free to send in patches and help improve this | ||
library. All patches are appreciated! |
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