👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to the Angular libraries, which are hosted in Werfen 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.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
This project and everyone participating in it is governed by the Code of Conduct.
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.
We have an Angular Task Force to help you. Please, reach out the channel in Teams.
This section guides you through submitting a bug report for an Angular library. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
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.
Bugs are tracked as GitHub issues. Create an issue on the 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 started with the library, e.g. which command exactly you used in the terminal, or how you started it 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 which help you demonstrate the steps or point out the part of library which the suggestion is related to.
- If you're reporting it crashed, include a crash report with a stack trace.
This section guides you through submitting an enhancement suggestion, 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 🔎.
Enhancement suggestions are tracked as GitHub issues. Create an enhancement on the repository and provide the following information by filling in the template.
- 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 which help you demonstrate the steps or point out the part of library which the suggestion is related to.
The process described here has several goals:
- Maintain library's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible library
- Enable a sustainable system for library's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- This repository is aligned with the feature-branch strategy. The branch naming convention is "bugfix- or feature-" plus the issue number in github. For example: bugfix-200
- Follow all instructions in the template
- The changes can be tested in your local before publishing. The library can be generated by running the command "npm pack". Then, you need to replace the systelab-components-wdio-test dependency in the package.json file of your project to refer to the path of the file generated by the pack command (i.e 'systelab-components-wdio-test': 'file:path/to/your/sytelab-components-wdio-test-1.0.0.tgz').
- 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.
- Before merging the pull request, the master branch needs to be merged into current. Then, the version in the package.json needs to be increased.
- Once it's merged, the author must transition it to the status "Ready to test" in the project
- Based upon need, the library will be published into the npm repository. This process must be done by an authorized user.