docs: remove not used sections #383
Conversation
ghost
assigned
| ``` | ||
| [commit] | ||
| template = /home/user/git-commit-template | ||
| ``` |
There was a problem hiding this comment.
This is not required anymore as instructed by @ianjdarrow
There was a problem hiding this comment.
Interesting, what is the reason?
There was a problem hiding this comment.
BTW I'm +1 on this - it's a significant hurdle to also ask a new contributor to add a commit sign off message.
There was a problem hiding this comment.
Just FYI for anyone else reading this, it's not required if we switch to a dual MIT+Apache2 licence since the Apache2 licence states:
Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions.
There was a problem hiding this comment.
I'm not sure if it should be still part of the guide until we've switched to MIT+Apache.
| "test" | ||
| ] | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I think our guideline should be to have a lint task run on pre-commit/push. It's a quick thing to run and saves a big round trip waiting for CI to fail. We don't need to mandate the specific module to use.
It appears to be in approval from the team ipfs/js-ipfs#1705
| @@ -184,7 +182,7 @@ We use [`aegir-docs`](https://github.com/dignifiedquire/aegir) for the actual ge | |||
|
|
|||
| ### Commits | |||
|
|
|||
| We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log. | |||
| We have very precise guidelines over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log. | |||
There was a problem hiding this comment.
I think this is the correct sentiment - I do not enforce this with new/existing contributors and it's trivial to correct in github with a squash+merge.
| ``` | ||
| [commit] | ||
| template = /home/user/git-commit-template | ||
| ``` |
There was a problem hiding this comment.
Interesting, what is the reason?
| We suggest either of these: | ||
|
|
||
| - [david-dm](https://david-dm.org/) | ||
| - [greenkeeper](http://greenkeeper.io/) to keep your dependencies up to date. |
There was a problem hiding this comment.
I'd like to add the Greenkeeper works well for IPLD. So we might reconsider using it. It changed a lot since it abandoned the last time.
| ``` | ||
| [commit] | ||
| template = /home/user/git-commit-template | ||
| ``` |
There was a problem hiding this comment.
I'm not sure if it should be still part of the guide until we've switched to MIT+Apache.
|
Missing License update coming with ipfs/team-mgmt#849 |
|
Just flagging the existence of this issue since it seems like it was awaiting the switch to MIT + Apache licensing that's now underway elsewhere. :) |
|
ipfs/js-ipfs#2624 and ipfs-inactive/js-ipfs-http-client#1189 but they are the tip of the iceberg. |
No description provided.