forked from adobe/aem-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changes to comply with Adobe Open Source guidelines (#49)
* Changes to comply with Adobe Open Source guidelines * Update PR template * Fix linting errors --------- Co-authored-by: Satya Deep Maheshwari <satyam@adobe.com>
- Loading branch information
Showing
19 changed files
with
154 additions
and
728 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
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,74 +1,47 @@ | ||
# Contributing to Project Helix | ||
# Contributing | ||
|
||
This project (like almost all of Project Helix) is an Open Development project and welcomes contributions from everyone who finds it useful or lacking. | ||
Thanks for choosing to contribute! | ||
|
||
## 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 cstaub at adobe dot com. | ||
|
||
## Contributor License Agreement | ||
|
||
All third-party contributions to this project must be accompanied by a signed contributor license. 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! | ||
|
||
## Things to Keep in Mind | ||
|
||
This project uses a **commit then review** process, which means that for approved maintainers, changes can be merged immediately, but will be reviewed by others. | ||
|
||
For other contributors, a maintainer of the project has to approve the pull request. | ||
|
||
# Before You Contribute | ||
|
||
* Check that there is an existing issue in GitHub issues | ||
* Check if there are other pull requests that might overlap or conflict with your intended contribution | ||
|
||
# How to Contribute | ||
|
||
1. Fork the repository | ||
2. Make some changes on a branch on your fork | ||
3. Create a pull request from your branch | ||
|
||
In your pull request, outline: | ||
|
||
* What the changes intend | ||
* How they change the existing code | ||
* If (and what) they breaks | ||
* Start the pull request with the GitHub issue ID, e.g. #123 | ||
|
||
Lastly, please follow the [pull request template](.github/pull_request_template.md) when submitting a pull request! | ||
|
||
Each commit message that is not part of a pull request: | ||
|
||
* Should contain the issue ID like `#123` | ||
* Can contain the tag `[trivial]` for trivial changes that don't relate to an issue | ||
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](../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). | ||
|
||
## Coding Styleguides | ||
## Have A Question? | ||
|
||
We enforce a coding styleguide using `eslint`. As part of your build, run `npm run lint` to check if your code is conforming to the style guide. We do the same for every PR in our CI, so PRs will get rejected if they don't follow the style guide. | ||
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). | ||
|
||
You can fix some of the issues automatically by running `npx eslint . --fix`. | ||
## Contributor License Agreement | ||
|
||
## Commit Message Format | ||
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](https://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! | ||
|
||
This project uses a structured commit changelog format that should be used for every commit. Use `npm run commit` instead of your usual `git commit` to generate commit messages using a wizard. | ||
## Code Reviews | ||
|
||
```bash | ||
# either add all changed files | ||
$ git add -A | ||
# or selectively add files | ||
$ git add package.json | ||
# then commit using the wizard | ||
$ npm run commit | ||
``` | ||
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. | ||
|
||
# How Contributions get Reviewed | ||
Lastly, please follow the [pull request template](PULL_REQUEST_TEMPLATE.md) when | ||
submitting a pull request! | ||
|
||
One of the maintainers will look at the pull request within one week. Feedback on the pull request will be given in writing, in GitHub. | ||
## From Contributor To Committer | ||
|
||
# Release Management | ||
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. | ||
|
||
The project's committers will release to the [Adobe organization on npmjs.org](https://www.npmjs.com/org/adobe). | ||
Please contact the [Adobe Open Source Advisory Board](https://git.corp.adobe.com/OpenSourceAdvisoryBoard/discuss/issues) to get access to the npmjs organization. | ||
## Security Issues | ||
|
||
The release process is fully automated using `semantic-release`, increasing the version numbers, etc. based on the contents of the commit messages found. | ||
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). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.