First off, thank you for considering contributing to our React App Boilerplate. It's people like you that make this boilerplate such a great tool.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open-source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
LoopStudio's React App Boilerplate is an open-source project and we love to receive contributions from our community — you! There are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the boilerplate itself.
We use our custom ESLint file to lint the code, so please make sure you set up the necessary tools in your preferred text editor. Pull Requests that do not adhere to our linting rules will be rejected.
The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests, but please respect the following restrictions:
- Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
-
Use the GitHub issue search — check if the issue has already been reported.
-
Check if the issue has been fixed — try to reproduce it using the
masterbranch in the repository. -
Isolate the problem — ideally, create a reduced test case.
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What OS experiences the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
Example:
Short and descriptive example bug report title
A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.
- This is the first step
- This is the second step
- Further steps, etc.
<url>- a link to the reduced test case, screenshots, videos, etc...Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise, you risk spending a lot of time working on something that the team might not want to merge into the project.
-
Make sure to update, or add to the tests when appropriate. Patches and features will not be accepted without tests. Run
npm testto check that all tests pass after you've made changes. Look for aTestingsection in the project’s README for more information. -
If you added or changed a feature, make sure to document it accordingly in the
README.mdfile. -
Open a Pull Request using your branch with a clear title and description.
- Check that a change is within the scope and philosophy of the component.
- Check that a change has any necessary tests.
- Check that a change has any necessary documentation.
- If there is anything you don’t like, leave a comment below the respective lines and submit a "Request changes" review. Repeat until everything has been addressed.
- If you are not sure about something, mention
@LoopStudioor specific people for help in a comment. - Once everything looks good, add an "Approve" review. Don’t forget to say something nice 👏🐶💖✨
** We require at least 2 approvals to consider a Pull Request good to be merged **
| Label name | Description |
|---|---|
feature |
Developing a new feature |
bug |
Fixing a bug |
chore |
Maintenance work. I.E: dependencies update, etc. |
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. For example, you might be interested in open issues across LoopStudio's repos and which are labeled as bugs, but still need to be reliably reproduced or perhaps open pull requests in LoopStudio/react-app-boilerplate which haven't been reviewed yet. To help you find issues and pull requests, each label is listed with search links for finding open items with that label in LoopStudio/react-app-boilerplate only and also across all LoopStudio's repositories. We encourage you to read about other search filters which will help you write more focused queries.
The labels are loosely grouped by their purpose, but it's not required that every issue has a label from every group or that an issue can't have more than one label from the same group.
Please open an issue on our style guides repo if you have suggestions for new labels, and if you notice some labels are missing on some repositories, then please open an issue on that repository.
| Label name | LoopStudio/react-app-boilerplate 🔎 |
LoopStudio‑org 🔎 |
Description |
|---|---|---|---|
enhancement |
search | search | Feature requests. |
bug |
search | search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | search | Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
search | search | General feedback more than bug reports or feature requests. |
help-wanted |
search | search | When help from the team in resolving these issues is needed. |
beginner |
search | search | Less complex issues which would be good first issues to work on for users who want to contribute. |
more-information-needed |
search | search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
search | search | Likely bugs, but haven't been reliably reproduced. |
blocked |
search | search | Issues blocked on other issues. |
duplicate |
search | search | Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
search | search | LoopStudio team has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
search | search | Issues which aren't valid (e.g. user errors). |
package-idea |
search | search | Feature request which might be good candidates for a library. |
wrong-repo |
search | search | Issues reported on the wrong repository. |
| Label name | LoopStudio/react-app-boilerplate 🔎 |
LoopStudio‑org 🔎 |
Description |
|---|---|---|---|
documentation |
search | search | Related to any type of documentation. |
performance |
search | search | Related to performance. |
security |
search | search | Related to security. |
ui |
search | search | Related to visual design. |
api |
search | search | Related to the boilerplate's APIs service. |
crash |
search | search | Reports of the boilerplate completely crashing. |
git |
search | search | Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status). |
build-error |
search | search | Related to problems with building the boilerplate from source |
deprecation-help |
search | search | Issues related to deprecation of APIs. |
| Label name | LoopStudio/react-app-boilerplate 🔎 |
LoopStudio‑org 🔎 |
Description |
|---|---|---|---|
work-in-progress |
search | search | Pull requests which are still being worked on, more changes will follow. |
depends-on-another-branch |
search | search | Pull requests which depends on another branch to be merged. |
needs-review |
search | search | Pull requests which need code review and approval from maintainers. |
under-review |
search | search | Pull requests being reviewed by maintainers. |
requires-changes |
search | search | Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
search | search | Pull requests which need manual testing. |
We gather together once a month to discuss industry trends, best practices, and, of course, this project, in what we decided to call Loop's React Tech Council.