-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: new contributing guidelines (#3485)
--------- Co-authored-by: Rajdeep Chandra <rajdeepc@adobe.com> Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
- Loading branch information
3 people
committed
Jul 28, 2023
1 parent
0cd3bcf
commit 6be9a5f
Showing
1 changed file
with
75 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,101 @@ | ||
| # Contributing | ||
| # How to Contribute to Spectrum Web Components | ||
|
|
||
| Thanks for choosing to contribute! | ||
| First off, thanks for taking the time to contribute! | ||
|
|
||
| The following are a set of guidelines to follow when contributing to this project. | ||
| The following are a set of guidelines for contributing to Spectrum Web Components, which is hosted on the [Adobe Spectrum Web Components repository](https://github.com/adobe/spectrum-web-components). These are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request if the need arises while contributing to the library. | ||
|
|
||
| ## Code Of Conduct | ||
|
|
||
| This project adheres to the Adobe [code of conduct](CODE_OF_CONDUCT.md). By participating, | ||
| you are expected to uphold this code. Please report unacceptable behavior to | ||
| [Grp-opensourceoffice@adobe.com](mailto:Grp-opensourceoffice@adobe.com). | ||
|
|
||
| ## Have A Question? | ||
| ## TL;DR | ||
|
|
||
| Start by filing an issue. The existing committers on this project work to reach | ||
| consensus around project direction and issue solutions within issue threads | ||
| (when appropriate). | ||
| > **Note:** [Please don't file an issue to ask a question.](https://github.com/adobe/spectrum-web-components/discussions) You'll get faster results by using the resources below. | ||
| ## Contributor License Agreement | ||
| We have an official message board with a detailed FAQ and where the community chimes in with helpful advice if you have questions. | ||
|
|
||
| - [Spectrum Web Components FAQ](https://github.com/adobe/spectrum-web-components/discussions/categories/q-a): Your question may have been asked before, take a quick look at the FAQ to see previous questions that may help you. | ||
| - [Github Discussions, the official Spectrum Web Components message board](https://github.com/adobe/spectrum-web-components/discussions): If you don't see a previously asked question, feel free to reach out to the team in the message board. | ||
|
|
||
| ## How Can I Contribute? | ||
|
|
||
| ### Contributor License Agreement | ||
|
|
||
| All third-party contributions to this project must be accompanied by a signed contributor | ||
| license agreement. This gives Adobe permission to redistribute your contributions | ||
| as part of the project. [Sign our CLA](http://opensource.adobe.com/cla.html). You | ||
| only need to submit an Adobe CLA one time, so if you have submitted one previously, | ||
| you are good to go! | ||
| license agreement. [Sign our CLA](http://opensource.adobe.com/cla.html). | ||
|
|
||
| ### Security Issues | ||
|
|
||
| Do not open up a GitHub issue if the bug is a security vulnerability in Spectrum Web Components, and instead to refer to our [security policy](https://helpx.adobe.com/security/alertus.html). | ||
|
|
||
| ## Did you find a bug? | ||
|
|
||
| ### Before Submitting A Bug Report | ||
|
|
||
| - Check the [Issue Discussions](https://github.com/adobe/spectrum-web-components/issues). | ||
| - You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem [in the latest version of Spectrum Web Components](https://studio.webcomponents.dev/workspace/adobe). | ||
|
|
||
| - Perform a [search](https://github.com/adobe/spectrum-web-components/issues) 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. | ||
|
|
||
| ### Report bugs using Github's [issues](https://github.com/adobe/spectrum-web-components/issues) | ||
|
|
||
| We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/adobe/spectrum-web-components/issues/new/choose); it's that easy! | ||
|
|
||
| ### Write bug reports with detail, background, and sample code | ||
|
|
||
| Create an issue on the repository and provide the following information by filling in [the template](https://github.com/adobe/spectrum-web-components/blob/main/.github/ISSUE_TEMPLATE/bug_report.yaml). | ||
|
|
||
| ## Code Reviews | ||
| - A quick summary and/or background | ||
| - Steps to reproduce - | ||
| - Please be specific! | ||
| - Reproduce your issue [here](https://studio.webcomponents.dev/workspace/adobe) | ||
| - What you would expect to happen | ||
| - What actually happens | ||
| - Notes (for example why you think this might be happening, or stuff you tried that didn't work) | ||
|
|
||
| All submissions should come in the form of pull requests and need to be reviewed | ||
| by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/) | ||
| for more information on sending pull requests. | ||
| ## Do you intend to add a new feature or change an existing one? | ||
|
|
||
| Lastly, please follow the [pull request template](PULL_REQUEST_TEMPLATE.md) when | ||
| submitting a pull request! | ||
| - Suggest your change in the [ideas list](https://github.com/adobe/spectrum-web-components/discussions/categories/ideas) and start writing code. | ||
|
|
||
| ## Commitlint | ||
| - Do not open an issue on GitHub until you have collected positive feedback about the change. You can start on [Adding your idea here](https://github.com/adobe/spectrum-web-components/discussions/categories/ideas) under Ideas | ||
|
|
||
| - Once your Idea or request is submitted, you can create an [issue](https://github.com/adobe/spectrum-web-components/issues/new/choose) with the New Component or a Feature Request template. | ||
|
|
||
| - Please make sure that your PR follows our [best practices](https://opensource.adobe.com/spectrum-web-components/migrations/2021-8-11/#using-lit%402.0-inside-of-lit-html-and%2For-litelement) and [styleguide](https://spectrum.corp.adobe.com/page/design-tokens/#Usage-guidelines) before you submit for review | ||
|
|
||
| ## Branching Strategy | ||
|
|
||
| ### Branch Naming Convention: | ||
|
|
||
| - Use `[username]/[issue]` format for branches. | ||
| - `[username]` identifies the contributor. | ||
| - `[issue]` refers to the associated issue or feature number. | ||
|
|
||
| For e.g: Be descriptive after the /, like `john-doe/123-fix-bug`. | ||
|
|
||
| ## Create your first Pull Request | ||
|
|
||
| - Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md) | ||
| - After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing. | ||
|
|
||
| ## Git Commit Messages | ||
|
|
||
| ### Commitlint | ||
|
|
||
| We use [Commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint) to help manage the semantic versions across the various packages in this library. Please be sure that you take this into concideration when submitting PRs to this repositiory. Generally, your commits should look like the following: | ||
|
|
||
| ``` | ||
| ```bash | ||
| type(scope?): subject #scope is optional, but should reference the package you are updating | ||
| ``` | ||
|
|
||
| ## From Contributor To Committer | ||
| We maintain a specific standard of commit messages while committing to the respository. See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) | ||
|
|
||
| ## Do you want to contribute to the Spectrum Web Components documentation? | ||
|
|
||
| We love contributions from our community! If you'd like to go a step beyond contributor | ||
| and become a committer with full write access and a say in the project, you must | ||
| be invited to the project. The existing committers employ an internal nomination | ||
| process that must reach lazy consensus (silence is approval) before invitations | ||
| are issued. If you feel you are qualified and want to get more deeply involved, | ||
| feel free to reach out to existing committers to have a conversation about that. | ||
| Please read [Contributing Guidelines for documentation](https://github.com/adobe/spectrum-web-components#documentation) | ||
|
|
||
| ## Security Issues | ||
| Thanks! :heart: :heart: :heart: | ||
|
|
||
| Security issues shouldn't be reported on this issue tracker. Instead, [file an issue to our security experts](https://helpx.adobe.com/security/alertus.html) | ||
| The Spectrum Web Components Team |