xfox111
5f34431b5a
* - Removed scenario test overrides * Fixed localization check issue * Added CI/CD configs * Updated README * Added yarn install to CI/CD configs * Update ci.yml * Updated CI config to attach built bundle to release * Added templates and documents to comply with GitHub Community Standards * Updated CI.yml
85 lines
4.1 KiB
Markdown
85 lines
4.1 KiB
Markdown
# Contribution Guidelines
|
|
Welcome, and thank you for your interest in contributing to our project!
|
|
|
|
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
|
|
|
|
## Table of Contents
|
|
- [Contribution Guidelines](#contribution-guidelines)
|
|
- [Table of Contents](#table-of-contents)
|
|
- [Asking Questions](#asking-questions)
|
|
- [Providing Feedback](#providing-feedback)
|
|
- [Reporting Issues](#reporting-issues)
|
|
- [Look For an Existing Issue](#look-for-an-existing-issue)
|
|
- [Writing Good Bug Reports and Feature Requests](#writing-good-bug-reports-and-feature-requests)
|
|
- [Final Checklist](#final-checklist)
|
|
- [Follow Your Issue](#follow-your-issue)
|
|
- [Contributing to the codebase](#contributing-to-the-codebase)
|
|
- [Deploy test version on your browser](#deploy-test-version-on-your-browser)
|
|
- [Development workflow](#development-workflow)
|
|
- [Release](#release)
|
|
- [Coding guidelines](#coding-guidelines)
|
|
- [Indentation](#indentation)
|
|
- [Names](#names)
|
|
- [Comments](#comments)
|
|
- [Strings](#strings)
|
|
- [Style](#style)
|
|
- [Finding an issue to work on](#finding-an-issue-to-work-on)
|
|
- [Contributing to translations](#contributing-to-translations)
|
|
- [Submitting pull requests](#submitting-pull-requests)
|
|
- [Spell check errors](#spell-check-errors)
|
|
- [Thank You!](#thank-you)
|
|
- [Attribution](#attribution)
|
|
|
|
## Asking Questions
|
|
Have a question? Rather than opening an issue, please ask me directly on opensource@foxdev.studio
|
|
|
|
## Providing Feedback
|
|
Your comments and feedback are welcome.
|
|
You can leave your feedback on feedback@foxdev.studio or do it on GitHub Discussions
|
|
|
|
## Reporting Issues
|
|
Have you identified a reproducible problem in the application? Have a feature request? We'd like to hear it! Here's how you can make reporting your issue as effective as possible.
|
|
|
|
### Look For an Existing Issue
|
|
Before you create a new issue, please do a search in [open issues](https://github.com/xfox111/TabsAsideExtension/issues) to see if the issue or feature request has already been filed.
|
|
|
|
Be sure to scan through the [feature requests](https://github.com/XFox111/TabsAsideExtension/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement).
|
|
|
|
If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment:
|
|
|
|
- 👍 - upvote
|
|
- 👎 - downvote
|
|
|
|
If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
|
|
|
|
### Writing Good Bug Reports and Feature Requests
|
|
File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
|
|
|
|
Do not add your issue as a comment to an existing issue unless they are the same ones. Many issues look similar, but have different causes.
|
|
|
|
The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a solution.
|
|
|
|
Please include the following with each issue:
|
|
- Current version of the extension
|
|
- Your current browser and OS name
|
|
- Reproducible steps (1... 2... 3...) that cause the issue
|
|
- What you expected to see, versus what you actually saw
|
|
- Images, animations, or a link to a video showing the issue occurring
|
|
|
|
### Final Checklist
|
|
Please remember to do the following:
|
|
|
|
- [ ] Search the issue repository to ensure your report is a new issue
|
|
- [ ] Separate issues reports
|
|
- [ ] Include as much information as you can to your report
|
|
|
|
Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!
|
|
|
|
### Follow Your Issue
|
|
Once your report is submitted, be sure to stay in touch with the devs in case they need more help from you.
|
|
|
|
## Thank You!
|
|
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.
|
|
|
|
## Attribution
|
|
These Contribution Guidelines are adapted from the [Contributing to VS Code](https://github.com/microsoft/vscode/blob/master/CONTRIBUTING.md) |