Thank you for investing your time in contributing to our project!
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
New contributor guide#
To get an overview of the project, read the docs. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
You can contribute to IdleTimer in several ways:
Discussions are where we have conversations.
If you'd like help troubleshooting a PR you're working on, have a great new idea, or want to share something amazing you've learned, join us in discussions.
Issues are used to track tasks that contributors can help with. If an issue has the
triage label, it has not been reviewed and you shouldn't begin work on it.
If you've found something in the source code or docs that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a template. We'll use the issue to have a conversation about the problem you want to fix.
A pull request is a way to suggest changes in our repository.
When we merge those changes, they will be deployed with the next release. To learn more about opening a pull request in this repo, see the Pull Request below.
IdleTimer is maintained by a very small team. If you would like to help, providing
community support would be a great way to start. You can join our discord to
offer your expertise to new users or participate in conversations on issues labeled
question or discussions.
Create a new issue#
If you spot a problem with the package or docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Solve an issue#
Scan through our existing issues to find one that interests you. You can narrow down the search using
labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
Setting up project locally#
- Fork the repository.
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
Install nodejs if you haven't already.
npm installto install package dependencies.
Run 'npm install -g nps` if you don't already have npm package scripts installed.
If you are working on the docs, you will need to add a
.env.localfile to the
/docsdirectory. Inside the file you will need to add the following and replace [your_token] with a github personal access token.
- Create a working branch and start with your changes!
All the scripts to work with IdleTimer can be found in
package-scripts.js. As a contributor the only scripts you should need are
nps.test for working on the source code and
nps docs.dev for working on the documentation.
Commit your update#
Commit the changes once you are happy with them. The following commit message guidelines will be strictly enforced.
Git Commit Messages#
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Start the commit message with an applicable emoji:
:art:When improving the format/structure of the code.
:stopwatch:When improving performance.
:memo:When writing docs.
:zap:When adding a new feature.
:sparkles:When enhancing an existing feature.
:lady_beetle:When fixing a bug.
:fire:When removing code or files.
:green_heart:When fixing the CI build.
:white_check_mark:When adding tests.
:lock:When dealing with security.
:arrow_up:When upgrading dependencies.
:arrow_down:When downgrading dependencies.
:shirt:When removing linter warnings.
:shower:When performing generic clean up.
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, your proposal will be reviewed. We may ask questions or request for additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Your PR is merged#
🎉 Congratulations 🎉 Your pull request has been merged and you are now an IdleTimer Contributor! Your contributions will published with the next release.