CONTRIBUTING.md 5.9 KB
Contributing in NoSleep.js
We'd always love contributions to further improve NoSleep.js!
Here are the guidelines we'd like you to follow:
- Questions and Problems
- Issues and Bugs
- Feature Requests
- Pull Request Submission Guidelines
- Commit Message Conventions
Got a Question or Problem?
Please submit support requests and questions to StackOverflow using the tag [nosleep]. The issue tracker is for bug reports and feature discussions.
Found an Issue or Bug?
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we ask that you to provide a minimal reproduction scenario (github repo or failing test case). Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:
- version of NoSleep.js used
- device manufacturer and device version information
- browser vendor and browser version information
- the use-case that fails
A minimal reproduce scenario allows us to quickly confirm a bug (or point out config problems) as well as confirm that we are fixing the right problem.
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.
Feature Requests?
You can request a new feature by creating an issue on Github.
If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that particular makes sense for the project.
Pull Request Submission Guidelines
Before you submit your Pull Request (PR) consider the following guidelines:
- Search Github for an open or closed PR that relates to your submission. You don't want to duplicate effort.
- Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
- Fill out our
Pull Request Template. Your pull request will not be considered if it is ignored. - Please sign the
Contributor License Agreement (CLA)when a pull request is opened. We cannot accept your pull request without this. Make sure you sign with the primary email address associated with your local / github account.
NoSleep.js Commit Conventions
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
The footer should contain a closing reference to an issue if any.
Examples:
docs(readme): update install instructions
fix: refer to the `entrypoint` instead of the first `module`
Revert
If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit.
In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Type
Must be one of the following:
- build: Changes that affect the build system or external dependencies (example scopes: babel, npm)
- chore: Changes that fall outside of build / docs that do not effect source code (example scopes: package, defaults)
- ci: Changes to our CI configuration files and scripts (example scopes: circleci, travis)
- docs: Documentation only changes (example scopes: readme, changelog)
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- revert: Used when reverting a committed change
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
- test: Addition of or updates to Jest tests
Scope
The scope is subjective & depends on the type see above. A good example would be a change to a particular class / module.
Subject
The subject contains a succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
Body
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
Footer
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
Example
BREAKING CHANGE: Updates to `Chunk.mapModules`.
This release is not backwards compatible with `NoSleep 1.x` due to breaking changes in richtr/NoSleep.js#4764
Migration: see richtr/NoSleep.js#5225