👍🎉 Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. 🎉👍
The following is a set of guidelines for contributing to Parallel and its packages, which are hosted in the eviden-parallel organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Atom Code of Conduct. By participating, you are expected to uphold this code.
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.
We have an official message board where the community chimes in with helpful advice if you have questions.
Parallel is project made up of multiple repositories. When you initially consider contributing to Parallel, you might be unsure about which of those repositories implements the functionality you want to change or report a bug for. This section should help you with that.
- @eviden-parallel/web - monorepo for Parallel web components. It is the source for both the
@eviden-parallel/coreand@eviden-parallel/componentspackages. - @eviden-parallel/icons - the icons that can be used with Parallel through the
@eviden-parallel/iconspackage. - @eviden-parallel/bootstrap - a custom style to make Bootstrap look like Parallel through the
@eviden-parallel/bootsrappackage. - @eviden-parallel/playground - For any kind of research and experimentation
- @eviden-parallel/welcome - tne welcome page for Parallel
There are more, but this list should be a good starting point.
Every part of Parallel is carefully crafted and reviewed by our design team before being implemented. It will be documented in our Design Documentation If you have a question around how we design things, check to see if it is documented there. If it is not documented there, please open a new topic on Github Discussions, the official Parallel message board and ask your question.
This section guides you through submitting a bug report for Parallel. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Check the discussions for a list of common questions and problems.
- Determine which repository the problem should be reported in.
- Perform a [cursory search](https://github.com/search?q=+is%3Aissue+org%3Aeviden-parallel to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you use Parallel, e.g. which command exactly you used in the terminal, or how you included Parallel otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut, and if so which one?
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- If the problem is related to performance or memory, include a performance profile or a [heap snapshots](https://docs.microsoft.com/en-us/microsoft-edge/devtools-guide-chromium/memory-problems/heap-snapshots with your report.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Can you reproduce the problem?
- Did the problem start happening recently (e.g. after updating to a new version of Parallel) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of Parallel? What's the most recent version in which the problem doesn't happen? You can download older versions of Parallel from the releases page.
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of Parallel are you using? You can get the exact version from the package-lock.json file in your project.
- What's the name and version of the OS you're using?
- Which packages do you have installed?.
- Are you using Parallel with multiple monitors? If so, can you reproduce the problem when you use a single monitor?
- Which keyboard layout are you using? Are you using a US layout or some other layout?
This section guides you through submitting an enhancement suggestion for Parallel, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the correct template for feature request and enhancement, including the steps that you imagine you would take if the feature you're requesting existed.
- Determine which repository the enhancement should be suggested in.
- Perform a [cursory search](https://github.com/search?q=+is%3Aissue+org%3Aeviden-parallel to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Parallel which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most Parallel users and isn't something that can or should be implemented as a community package.
- List some other design systems or applications where this enhancement exists.
- Specify which version of Parallel are you using? You can get the exact version from the package-lock.json file in your project.
- Specify the name and version of the OS you're using.
Unsure where to begin contributing to Parallel? You can start by looking through these 🆘 help wanted issues:
The process described here has several goals:
- Maintain Parallel's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Parallel
- Enable a sustainable system for Parallel's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- To avoid concurent work on the same task, assign the issue(s) to yourself or if you are external contributor, comment on the issue with
@eviden-parallel/maintainers assign meto have maintainers assign the issue to you. - Create a new branch for each pull request (PR) following the branch naming convention. External contributors should fork the repository and create the branch in their fork ideally also following the branch naming convention.
- Open the PR as soon as possible in status
Draftuntil it is ready for review. - After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
Here are a addit few things you can do that will increase the likelihood of your pull request being accepted:
- Read the contributing guidelines.
- Branch name follows Branching guidelines.
- Commits follows Commit guidelines.
- Write a good commit message.
- Design matches Styleguide
- Write tests whenever applicable.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
Develoment branches should follow the following format: <type>/<name>
To make it easier, type uses the same values as the type in commit messages and must be one of the following:
| Type | Description |
|---|---|
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) |
docs |
Documentation only changes |
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 |
style |
Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
test |
Adding missing tests or correcting existing tests |
chore |
Changes to the build process or auxiliary tools (example scopes: gulp, broccoli, npm) |
reasearch |
Researching and learning new technologies |
The following branches are used for releases. Changes should be made to development branches and merge into release branches through pull requests.
| Branch | Tag | Description |
|---|---|---|
main |
latest | Currentey released version |
next |
next | Released version, not yet ready for prime time |
beta |
beta | Beta version |
alpha |
alpha | Alpha version |
release-<version> |
<version> |
LTS version |
Commit messages are used for automatic versioning. It is therefor following the conventional commits guidelines.
The commit message format will be checked in the project using pre-commit hooks.
The format is defined as follows:
<type>([optional scope]): <description>
[optional body]
[optional footer(s)]
Type must be one of the following: To make it easier, type uses the same values as the type in commit messages and must be one of the following:
| Type | Description |
|---|---|
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) |
docs |
Documentation only changes |
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 |
style |
Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
test |
Adding missing tests or correcting existing tests |
chore |
Changes to the build process or auxiliary tools (example scopes: gulp, broccoli, npm) |
Breaking changes should be marked with BREAKING CHANGE in the commit message body or with a ! after the commit type/scope.
e.g.:
chore(deps)!: drop support for Node 6
BREAKING CHANGE: use JavaScript features not available in Node 6.