-
Notifications
You must be signed in to change notification settings - Fork 197
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #279 from adobe/ccc
Conventional Commits & Changelogs
- Loading branch information
Showing
48 changed files
with
10,958 additions
and
9,602 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 |
---|---|---|
|
@@ -4,31 +4,31 @@ We love pull requests from everyone. | |
|
||
The following are a set of guidelines to follow when contributing to this project. | ||
|
||
## Code Of Conduct | ||
## 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 | ||
[[email protected]](mailto:[email protected]). | ||
|
||
## Have A Question? | ||
## 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 | ||
|
||
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). | ||
|
||
## Contributor License Agreement | ||
## 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! | ||
|
||
## Code Reviews | ||
## Submitting a contribution | ||
|
||
All submissions should come in the form of pull requests and need to be reviewed | ||
by project committers. | ||
|
@@ -47,16 +47,22 @@ git push -u origin my-awesome-new-feature | |
git remote add upstream [email protected]:adobe/spectrum-css.git | ||
``` | ||
|
||
Install dependencies (`npm ci` won't work unless you're inside the Adobe network): | ||
Install [yarn](https://yarnpkg.com/en/docs/install): | ||
|
||
``` | ||
npm install | ||
brew install yarn || curl -o- -L https://yarnpkg.com/install.sh | bash | ||
``` | ||
|
||
Make sure the [gulp-cli](https://github.com/gulpjs/gulp-cli) is installed globally: | ||
|
||
``` | ||
npm install -g gulp-cli | ||
yarn global add gulp-cli | ||
``` | ||
|
||
Install dependencies: | ||
|
||
``` | ||
yarn install | ||
``` | ||
|
||
Build the project, open a livereloading browser window, and watch for changes: | ||
|
@@ -65,41 +71,11 @@ Build the project, open a livereloading browser window, and watch for changes: | |
gulp dev | ||
``` | ||
|
||
Commit changes, referencing the relevant issue number (if any): | ||
|
||
``` | ||
git commit -m "Cool stuff, closes #250, fixes #252" | ||
``` | ||
|
||
Consider starting the commit message with an applicable emoji: | ||
|
||
* :art: `:art:` when improving the format/structure of the code | ||
* :zap: `:zap:` when improving performance | ||
* :non-potable_water: `:non-potable_water:` when plugging memory leaks | ||
* :memo: `:memo:` when writing docs | ||
* :ambulance: `:ambulance:` a critical hotfix. | ||
* :sparkles: `:sparkles:` when introducing new features | ||
* :bookmark: `:bookmark:` when releasing / version tags | ||
* :rocket: `:rocket:` when deploying stuff | ||
* :penguin: `:penguin:` when fixing something on Android | ||
* :apple: `:apple:` when fixing something on iOS | ||
* :checkered_flag: `:checkered_flag:` when fixing something on Windows | ||
* :bug: `:bug:` when fixing a bug | ||
* :fire: `:fire:` when removing code or files | ||
* :green_heart: `:green_heart:` when fixing the CI build | ||
* :white_check_mark: `:white_check_mark:` when adding tests | ||
* :lock: `:lock:` when dealing with security | ||
* :arrow_up: `:arrow_up:` when upgrading dependencies | ||
* :arrow_down: `:arrow_down:` when downgrading dependencies | ||
* :shirt: `:shirt:` when removing linter warnings | ||
* :hammer: `:hammer:` when doing heavy refactoring | ||
* :heavy_minus_sign: `:heavy_minus_sign:` when removing a dependency. | ||
* :heavy_plus_sign: `:heavy_plus_sign:` when adding a dependency. | ||
* :wrench: `:wrench:` when changing configuration files. | ||
* :globe_with_meridians: `:globe_with_meridians:` when dealing with internationalization and localization. | ||
* :pencil2: `:pencil2:` when fixing typos. | ||
* :hankey: `:hankey:` when writing bad code that needs to be improved. | ||
* :package: `:package:` when updating compiled files or packages. | ||
Commit changes with a [conventional commit message](https://www.conventionalcommits.org), 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: | ||
|
||
|
@@ -120,6 +96,6 @@ At this point you're waiting on us. We do our best to keep on top of all the pul | |
|
||
Some things that will increase the chance that your pull request is accepted: | ||
|
||
- Write a [good commit message](http://chris.beams.io/posts/git-commit/). | ||
- Write a good pull request description, include screenshots, and test your changes across all evergreen browsers (and IE 11, sadly) | ||
- Make sure the PR merges cleanly with the latest master. | ||
- Describe your feature/bugfix and why it's needed/important in the pull request description. |
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,33 +1,27 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
<!-- Summarize your changes in the Title field --> | ||
|
||
## Description | ||
<!--- Describe your changes in detail --> | ||
<!-- | ||
Note: Before sending a pull request, make sure there's an issue for what you're changing | ||
- Search for issues: https://github.com/adobe/spectrum-css/issues | ||
- If there's no issue, file it: https://github.com/adobe/spectrum-css/issues/new/choose | ||
--> | ||
<!-- Describe what you changed and link to the relevant issue(s) (e.g., #000) --> | ||
|
||
## Related Issue | ||
<!--- This project only accepts pull requests related to open issues --> | ||
<!--- If suggesting a new feature or change, please discuss it in an issue first --> | ||
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> | ||
<!--- Please link to the issue here: --> | ||
|
||
## Motivation and Context | ||
<!--- Why is this change required? What problem does it solve? --> | ||
## How and where has this been tested? | ||
|
||
## How Has This Been Tested? | ||
<!--- Please describe in detail how you tested your changes. --> | ||
<!--- Include details of your testing environment, and the tests you ran to --> | ||
<!--- see how your change affects other areas of the code, etc. --> | ||
- How this was tested: <!-- Using steps in issue #000 --> | ||
- Browser(s) and OS(s) this was tested with: <!-- Chrome 75.0.3770.142 on Win 10 --> | ||
|
||
## Screenshots (if appropriate): | ||
## Screenshots | ||
<!-- If applicable, add screenshots to show what you changed --> | ||
|
||
## Types of changes | ||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
|
||
## Checklist: | ||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
- [ ] My change requires a change to the documentation. | ||
- [ ] I have updated the documentation accordingly. | ||
- [ ] I have read the **CONTRIBUTING** document. | ||
## To-do list | ||
<!-- Put an "x" to indicate you've done each of the following --> | ||
- [ ] If my change impacts other components, I have tested to make sure they don't break. | ||
- [ ] If my change impacts documentation, I have updated the documentation accordingly. | ||
- [ ] I have read the [CONTRIBUTING document](/.github/CONTRIBUTING.md). | ||
<!-- If this pull request isn't ready, add any remaning tasks here --> | ||
- [ ] This pull request is ready to merge. |
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
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
ignore-optional true |
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
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
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 +1 @@ | ||
module.exports = require('@spectrum-css/bundle-builder'); | ||
module.exports = require('../../tools/bundle-builder'); |
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
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
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 +1 @@ | ||
module.exports = require('@spectrum-css/bundle-builder'); | ||
module.exports = require('../../tools/bundle-builder'); |
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
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module.exports = { | ||
extends: ['@commitlint/config-conventional'] | ||
}; |
Oops, something went wrong.