Skip to content

vale and mklint editorial updates - CONTRIBUTING.md #163

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

Merged
MadelineMurray merged 21 commits into from
Feb 20, 2020
Merged

vale and mklint editorial updates - CONTRIBUTING.md #163

Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
67d91bc
Added default data location (#123)
MadelineMurray Jan 31, 2020
5f9c72e
Moved license note (#129)
MadelineMurray Jan 31, 2020
8e148d4
Windows is now supported in the quickstart (#143)
EdJoJob Feb 6, 2020
1237fdb
quickstart updates all round (#141)
joshuafernandes Feb 9, 2020
684c6bf
Fixed typo (#150)
MadelineMurray Feb 10, 2020
a4ecc0c
Add multi-tenancy information. (#131)
bgravenorst Feb 10, 2020
333cfb5
Apply renames for the quickstart repo (#152)
EdJoJob Feb 12, 2020
755d487
Added content on protocol upgrades (#132)
MadelineMurray Feb 13, 2020
1bfe9ba
Moved license note (#129)
MadelineMurray Jan 31, 2020
fae2874
Fixed typo (#150)
MadelineMurray Feb 10, 2020
ae88d11
Added content on protocol upgrades (#132)
MadelineMurray Feb 13, 2020
ef10c51
vale and mklint editorial updates - CONTRIBUTING.md
Feb 13, 2020
be04bd3
heading 2 update
Feb 13, 2020
1ded01a
Fixed Ansible link and renamed topic (#168)
MadelineMurray Feb 14, 2020
786639f
permissioning (#170)
wslyvh Feb 14, 2020
dda7f89
Vale and mdlint editorial updates - DCO.md (#162)
Feb 14, 2020
a6bc630
Removed ! from heading
Feb 17, 2020
ddd6eb7
updated CI and customised checks (#165)
NicolasMassart Feb 19, 2020
b80f225
Fixed up long links plus sentence case for headings
Feb 20, 2020
5ae263e
Merge branch 'master' into grantnoble-contributing-vale-mdlint
Feb 20, 2020
8a9bd58
Merge branch 'master' into grantnoble-contributing-vale-mdlint
MadelineMurray Feb 20, 2020
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
32 changes: 17 additions & 15 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
# Contributing to the Hyperledger Besu Documentation
## :tada: Thanks for taking the time to contribute! :tada:
# Contributing to the Hyperledger Besu documentation

## Thanks for taking the time to contribute

Welcome to the **Hyperledger Besu documentation** repository! The following are links to a set of guidelines for contributing to this repo.
These are mostly guidelines, not rules. Use your best judgement,
and feel free to propose changes to this document in a pull request.
Welcome to the **Hyperledger Besu documentation** repository! The following are links to a set of
guidelines for contributing to this repository. These are mostly guidelines, not rules. Use your
best judgement, and feel free to propose changes to this document in a pull request.

* [Hyperledger Besu documentation](http://besu.hyperledger.org/)
* [Hyperledger Besu Rocketchat](https://chat.hyperledger.org/channel/besu)
* [Hyperledger Besu Wiki](https://wiki.hyperledger.org/display/BESU/Hyperledger+Besu)

### Useful docs contributing links

* [I just have a quick question](https://wiki.hyperledger.org/display/BESU/I+just+have+a+quick+question)
* [How to Contribute]
* [Reporting Bugs in the Doc](https://wiki.hyperledger.org/display/BESU/Reporting+Bugs+in+the+Doc)
* [Submitting a Documentation Enhancement Suggestion](https://wiki.hyperledger.org/display/BESU/Suggesting+Documentation+Enhancements)
* [Documentation Style Guide](https://wiki.hyperledger.org/display/BESU/Besu+Documentation+Style+Guide)
* [Pull Request Labels](https://wiki.hyperledger.org/display/BESU/Pull+Request+Labels)

* [I just have a quick question]
* [How to contribute](https://wiki.hyperledger.org/display/BESU/How+to+Contribute)
* [Reporting bugs in the documentation]
* [Submitting a documentation enhancement suggestion]
* [Documentation style guide]
* [Pull request labels](https://wiki.hyperledger.org/display/BESU/Pull+Request+Labels)
* [Security](SECURITY.md)


### Other important information

* [Besu Roadmap](https://wiki.hyperledger.org/display/BESU/Roadmap)
* [Besu roadmap](https://wiki.hyperledger.org/display/BESU/Roadmap)
Copy link
Copy Markdown
Contributor

@NicolasMassart NicolasMassart Feb 14, 2020

Choose a reason for hiding this comment

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

Do other titles like "Code of Conduct", "Submitting a Documentation Enhancement Suggestion" , "Documentation Style Guide" and "Pull Request Labels" have to be sentence cased too?

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 17, 2020

Choose a reason for hiding this comment

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

I would have thought so if that is our style.

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 20, 2020

Choose a reason for hiding this comment

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

Updated, plus fixed up the long links.

* [Code of Conduct](https://wiki.hyperledger.org/display/BESU/Code+of+Conduct)
* [Governance](https://wiki.hyperledger.org/display/BESU/Governance)

[How to Contribute]: https://wiki.hyperledger.org/display/BESU/How+to+Contribute
<!-- Links -->
[I just have a quick question]: https://wiki.hyperledger.org/display/BESU/I+just+have+a+quick+question
[Reporting bugs in the documentation]: https://wiki.hyperledger.org/display/BESU/Reporting+Bugs+in+the+Doc
[Submitting a documentation enhancement suggestion]: https://wiki.hyperledger.org/display/BESU/Suggesting+Documentation+Enhancements
[Documentation style guide]: https://wiki.hyperledger.org/display/BESU/Besu+Documentation+Style+Guide