Thanks a lot for your interest in contributing to Thream/socketio-jwt! 🎉
Thream has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.
All work on Thream happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.
- Reporting a bug.
- Suggest a new feature idea.
- Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).
- Improve structure/format/performance/refactor/tests of the code.
-
Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time.
-
Ensure your code respect linting.
-
Make sure your code passes the tests.
If you're adding new features to Thream/socketio-jwt, please include tests.
The commit message guidelines respect @commitlint/config-conventional and Semantic Versioning for releases.
Types define which kind of changes you made to the project.
| Types | Description |
|---|---|
| feat | A new feature. |
| fix | A bug fix. |
| docs | Documentation only changes. |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). |
| refactor | A code change that neither fixes a bug nor adds a feature. |
| perf | A code change that improves performance. |
| test | Adding missing tests or correcting existing tests. |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm). |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
| chore | Other changes that don't modify src or test files. |
| revert | Reverts a previous commit. |
Scopes define what part of the code changed.