Skip to content

Latest commit

 

History

History
101 lines (59 loc) · 5.78 KB

CONTRIBUTING.md

File metadata and controls

101 lines (59 loc) · 5.78 KB
Raw

How to Contribute to Spectrum Web Components

First off, thanks for taking the time to contribute!

The following are a set of guidelines for contributing to Spectrum Web Components, which is hosted on the Adobe Spectrum Web Components repository. 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. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

TL;DR

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 with a detailed FAQ and where the community chimes in with helpful advice if you have questions.

How Can I Contribute?

Contributor License Agreement

All third-party contributions to this project must be accompanied by a signed contributor license agreement. Sign our CLA.

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.

Did you find a bug?

Before Submitting A Bug Report

  • Check the Issue Discussions.

  • 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.

  • Perform a search 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

We use GitHub issues to track public bugs. Report a bug by opening a new issue; 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.

  • A quick summary and/or background
  • Steps to reproduce -
    • Please be specific!
    • Reproduce your issue here
  • 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)

Do you intend to add a new feature or change an existing one?

  • Suggest your change in the ideas list and start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. You can start on Adding your idea here under Ideas

  • Once your Idea or request is submitted, you can create an issue with the New Component or a Feature Request template.

  • Please make sure that your PR follows our best practices and styleguide 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

Git Commit Messages

Commitlint

We use 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:

type(scope?): subject #scope is optional, but should reference the package you are updating

We maintain a specific standard of commit messages while committing to the respository. See Conventional Commits

Do you want to contribute to the Spectrum Web Components documentation?

Please read Contributing Guidelines for documentation

Thanks! ❤️ ❤️ ❤️

The Spectrum Web Components Team