Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

107 lines (71 loc) · 3.33 KB
Raw

Contributing

We love pull requests from everyone.

The following are a set of guidelines to follow when contributing to this project.

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 Grp-opensourceoffice@adobe.com.

Have a question?

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

Security issues

Security issues shouldn't be reported on this issue tracker. Instead, file an issue to our security experts.

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. You only need to submit an Adobe CLA one time, so if you have submitted one previously, you are good to go!

Submitting a contribution

All submissions should come in the form of pull requests and need to be reviewed by project committers.

Start by forking the repo, then clone your fork:

git clone git@github.com:yourusername/spectrum-css.git

Set up a branch for your feature or bug fix, push it to your fork, and set up a remote for the upstream repo:

git checkout -b my-awesome-new-feature
git push -u origin my-awesome-new-feature
git remote add upstream git@github.com:adobe/spectrum-css.git

Install yarn:

brew install yarn || curl -o- -L https://yarnpkg.com/install.sh | bash

Make sure the gulp-cli is installed globally:

yarn global add gulp-cli

Install dependencies:

yarn install

To generate a new component, run the generator:

yarn new component

Build the project, open a livereloading browser window, and watch for changes:

yarn dev

Commit changes with a conventional commit message, making sure to correctly use feat:, fix:, and BREAKING CHANGE accordingly, and referencing the relevant issue number (if any):

git commit -m "fix: calendar rendering issue in Safari, fixes #252"

Make sure your branch is up to date with the original repo:

git fetch upstream
git merge upstream/main

Review your changes and any possible conflicts and push to your fork:

git push origin

Submit a pull request.

At this point you're waiting on us. We do our best to keep on top of all the pull requests. We may suggest some changes, improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

  • Write a thorough pull request description, include screenshots, and test your changes across all evergreen browsers.
  • Make sure the PR merges cleanly with the latest main.
  • Describe your feature/bugfix and why it's needed/important in the pull request description.