| 1 | # Contributing to JSON Schema Markdown Tools
|
| 2 |
|
| 3 | This project is an Open Development/Inner Source project and welcomes contributions from everyone who finds it useful or lacking.
|
| 4 |
|
| 5 | ## Code Of Conduct
|
| 6 |
|
| 7 | 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.
|
| 8 |
|
| 9 | ## Contributor License Agreement
|
| 10 |
|
| 11 | 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!
|
| 12 |
|
| 13 | ## Things to Keep in Mind
|
| 14 |
|
| 15 | 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.
|
| 16 |
|
| 17 | For other contributors, a maintainer of the project has to approve the pull request.
|
| 18 |
|
| 19 | # Before You Contribute
|
| 20 |
|
| 21 | * Check that there is an existing issue in GitHub issues
|
| 22 | * Check if there are other pull requests that might overlap or conflict with your intended contribution
|
| 23 |
|
| 24 | # How to Contribute
|
| 25 |
|
| 26 | 1. Fork the repository
|
| 27 | 2. Make some changes on a branch on your fork
|
| 28 | 3. Create a pull request from your branch
|
| 29 |
|
| 30 | In your pull request, outline:
|
| 31 |
|
| 32 | * What the changes intend
|
| 33 | * How they change the existing code
|
| 34 | * If (and what) they breaks (TODO: we should have tests instead. pst: working on that ;) )
|
| 35 | * Start the pull request with the GitHub issue ID, e.g. #123
|
| 36 |
|
| 37 | Lastly, please follow the [pull request template](PULL_REQUEST_TEMPLATE.md) when submitting a pull request!
|
| 38 |
|
| 39 | Each commit message that is not part of a pull request:
|
| 40 |
|
| 41 | * Should contain the issue ID like `#123`
|
| 42 | * Can contain the tag `[trivial]` for trivial changes that don't relate to an issue
|
| 43 |
|
| 44 |
|
| 45 |
|
| 46 | ## Coding Styleguides
|
| 47 |
|
| 48 | There are no coding style guides... yet.
|
| 49 |
|
| 50 | # How Contributions get Reviewed
|
| 51 |
|
| 52 | One of the maintainers will look at the pull request within one week. If you haven't heard back from the maintainers within a week, it is not impolite to send a reminder to [Grp-XDM-API-WGs](mailto:Grp-XDM-API-WGs@adobe.com).
|
| 53 |
|
| 54 | Feedback on the pull request will be given in writing, in GitHub.
|
| 55 |
|
| 56 | ## Commit Message Format
|
| 57 |
|
| 58 | 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.
|
| 59 |
|
| 60 | ```bash
|
| 61 | # either add all changed files
|
| 62 | $ git add -A
|
| 63 | # or selectively add files
|
| 64 | $ git add package.json
|
| 65 | # then commit using the wizard
|
| 66 | $ npm run commit
|
| 67 | ```
|
| 68 |
|
| 69 | # Release Management
|
| 70 |
|
| 71 | The project's committers will release to the [Adobe organization on npmjs.org](https://www.npmjs.com/org/adobe).
|
| 72 | Please contact the [Adobe Open Source Advisory Board](https://git.corp.adobe.com/OpenSourceAdvisoryBoard/discuss/issues) to get access to the npmjs organization.
|
| 73 | Then, you can release using:
|
| 74 |
|
| 75 | The release process is fully automated using `semantic-release`, increasing the version numbers, etc. based on the contents of the commit messages found. |
| \ | No newline at end of file |