Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Document adoption of Conventional Commits. #685

Merged
merged 3 commits into from
Sep 5, 2017
Merged

Document adoption of Conventional Commits. #685

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
03a0f3d
docs(contributing): link Code of Conduct from summary "Be kind"
apetro Sep 5, 2017
211588d
docs(contributing): Note use Conventional Commits
apetro Sep 5, 2017
3517c83
docs(contributing): Alphabetize reference links
apetro Sep 5, 2017
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: 44 additions & 7 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

In short:

+ Be kind
+ [Be kind][code of conduct].
+ All Contributors must appear in the public [Apereo CLA roster][].
+ Use [Google code style][].
+ Use [Conventional Commits][].

However: *please do not let contribution guidance be an insurmountable barrier to your contribution.* Project participants can work with you to hone your contribution, but only if we know you're trying to contribute.

## Code of conduct

Expand Down Expand Up @@ -43,15 +46,49 @@ npm run lint-md
npm run lint-less
```

## Conventional Commits

We use [Conventional Commits][] as our commit message format. This leads to more
uniform messages in the project history.

### Type

We use [the change types Angular uses][].


### Scope

We have not yet formalized scopes. In practice scopes used so far include:

+ `changelog`
+ `ci`
Copy link
Contributor

@ChristianMurphy ChristianMurphy Sep 5, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

❓ ci is already a type, do we also want it to be a scope?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope. :)

+ `dependency`
+ `dependency upgrade`
+ `github`
+ `md`
+ `npm`
+ `package`
Copy link
Contributor

@ChristianMurphy ChristianMurphy Sep 5, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

❓ what is the difference between dependency, dependency upgrade, and package?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Dunno. Colorable argument for collapsing these. I figured the first step towards that was writing down what we've got so far.

+ `readme`

## Contribution welcome

Contribution guidance is intended to help you make the most effective contributions you can. Contribution guidance is **not intended to be a barrier to contributions, especially not to newcomer contributions.**

The [code of conduct][] is not negotiable. Please do be kind.

Everything else the project participants welcome helping you to work through in your contributions.


[AngularJS-portal website on incubating]: http://uw-madison-doit.github.io/angularjs-portal/apereo-incubation.html
[Apereo CLA roster]: http://licensing.apereo.org/completed-clas
[Apereo Corporate Contributor License Agreement]: https://www.apereo.org/sites/default/files/Licensing%20Agreements/apereo-ccla.pdf
[Apereo inbound intellectual property licensing practices]: https://www.apereo.org/licensing/practices
[Apereo Individual Contributor License Agreement]: https://www.apereo.org/sites/default/files/Licensing%20Agreements/apereo-icla.pdf
[Apereo Corporate Contributor License Agreement]: https://www.apereo.org/sites/default/files/Licensing%20Agreements/apereo-ccla.pdf
[Apereo website on licensing]: https://www.apereo.org/licensing
[Apereo website on Contributor License Agreement]: https://www.apereo.org/licensing/agreements
[Apereo licensing discussion Google Group]: https://groups.google.com/a/apereo.org/forum/#!forum/licensing-discuss
[Apereo CLA roster]: http://licensing.apereo.org/completed-clas

[Google code style]: https://google.github.io/styleguide/
[Apereo website on Contributor License Agreement]: https://www.apereo.org/licensing/agreements
[Apereo website on licensing]: https://www.apereo.org/licensing
[Apereo Welcoming Policy]: https://www.apereo.org/content/apereo-welcoming-policy
[code of conduct]: ../CODE_OF_CONDUCT.md
[Conventional Commits]: https://conventionalcommits.org/
[Google code style]: https://google.github.io/styleguide/
[the change types Angular uses]: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit