Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove not used sections #383

Closed
wants to merge 1 commit into from
Closed

docs: remove not used sections #383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 2 additions & 49 deletions CONTRIBUTING_JS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Our toolkit for each of these is not set in stone, and we don't plan to halt our
- [Documentation](#documentation)
- [Commits](#commits)
- [Commit Message Format](#commit-message-format)
- [Sign-off on commits](#sign-off-on-commits)
- [Revert](#revert)
- [Type](#type)
- [Scope](#scope)
Expand All @@ -44,7 +43,6 @@ Our toolkit for each of these is not set in stone, and we don't plan to halt our
- [`.gitignore`](#gitignore)
- [`.npmignore`](#npmignore)
- [Dependency management](#dependency-management)
- [Pre-Commit](#pre-commit)
- [Building](#building)
- [...for consumers](#for-consumers)
- [FAQ](#faq)
Expand Down Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard ([Commitizen](https://github.com/commitizen/cz-cli)).

Expand All @@ -204,36 +202,6 @@ The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

#### Sign-off on commits

We kindly ask and expect for all commits to be signed off with the same license as the repo and module. This can be done by appending the following to your commit message:

```
License: MIT
Signed-off-by: User Name <email@address>
```

where "User Name" is the author's real (legal) name and email@address is one of the author's valid email addresses.

If you want to automatically add this to all of your commits, you can do the following:

Create a file in `~/git-commit-template` with the following contents (notice the two blank lines in the top):

```


License: MIT
Signed-off-by: Victor Bjelkholm <[email protected]>
```

Then, add the following to your global git config (Usually at `~/.gitconfig`):

```
[commit]
template = /home/user/git-commit-template
```
Copy link
Member Author

@daviddias daviddias Jan 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not required anymore as instructed by @ianjdarrow

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, what is the reason?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW I'm +1 on this - it's a significant hurdle to also ask a new contributor to add a commit sign off message.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if it should be still part of the guide until we've switched to MIT+Apache.



#### Revert

If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
Expand Down Expand Up @@ -406,24 +374,10 @@ NPM uses the `.gitignore` by default, so we have to add a `.npmignore` file to e

##### Dependency management

We suggest either of these:

- [david-dm](https://david-dm.org/)
- [greenkeeper](http://greenkeeper.io/) to keep your dependencies up to date.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

We suggest using [david-dm](https://david-dm.org) for tracking dep versions.

Every module below 1.0.0 should use `~` instead of `^`.

##### Pre-Commit

[pre-commit](https://www.npmjs.com/package/pre-commit) helps us check code style run the tests on every commit. In your `package.json`:

```json
"pre-commit": [
"lint",
"test"
]
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

##### Building

You can get a bundled version by running `npm run build`, an npm script we add to the `package.json`. You can find the generated bundle in the `/dist` folder. This is available for every project that uses `aegir`.
Expand All @@ -447,7 +401,6 @@ const API = require('ipfs-api')

## FAQ


#### Why are you not using XYZ?

There are two possibilities: either it didn’t work out for us, or we don’t know about it. If you think we might have missed it please tell us, but please believe us if we say we tried and it didn’t work for us.
Expand Down