contributing guidelines review #457
Merged
Conversation
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
Member
daviddias
commented
Mar 3, 2020
•
daviddias
commented
- Reorder sections on the main doc, clearly separate "ways to contribute" from "protocol specification" from "guidelines for PRs"
- Remove duplication that existed in the Contributing_JS.md
- Remove some stuff that we don't do
achingbrain
approved these changes
Mar 3, 2020
| We use [documentation.js](https://github.com/documentationjs/documentation/tree/master/docs) to document our JavaScript repositories. An example for how to use JSDoc to document everything can be seen in [this PR to js-ipfs](https://github.com/ipfs/js-ipfs/pull/651). Ideally, we create a `docs` folder in each repository, and make sure it is not tracked to git. | ||
|
|
||
| We use [`aegir-docs`](https://github.com/dignifiedquire/aegir) for the actual generation, which relies on JSDoc style comments. For more on aegir, see [the section below](#aegir). | ||
| `TBW` |
There was a problem hiding this comment.
Does this section want removing for the time being? What does TBW mean?
There was a problem hiding this comment.
To be written. Right now, AFAIK we don't use nor rely on documentation.js for anything.
| **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. | ||
|
|
||
| #### Examples | ||
| Examples: |
There was a problem hiding this comment.
Could you add an example with a breaking change message please?
There was a problem hiding this comment.
@achingbrain there is already one below ;)
There was a problem hiding this comment.
There's an example, but it's just a regular feature commit?
alanshaw
requested changes
Mar 3, 2020
| **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. | ||
|
|
||
| #### Examples | ||
| Examples: |
There was a problem hiding this comment.
@achingbrain there is already one below ;)
Co-Authored-By: Alan Shaw <[email protected]>
Co-Authored-By: Alan Shaw <[email protected]>
|
Thank you for the review @alanshaw & @achingbrain. I took in your suggestions! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.