vacp2p/linea-besu
1
0
Fork 0
mirror of https://github.com/vacp2p/linea-besu.git synced 2026-01-09 21:17:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

Cleaned up outstanding TODOs in documentation (#192)

Browse Source 
- Created CLA.md
- Updated Gitter URLs
- Updated Role definitions
- deleted java-modules.md.  If written, it belongs in the JavaDoc package.hmtl
- Removed broken index link to Documentation Style Guide
- Fixed broken link to PR labels
- Converted issue templates to comment out each line individually
Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
This commit is contained in:
Eric Kellstrand
2018-10-26 17:15:09 -04:00
committed by GitHub
parent 0ce5817857
commit 7394ad7c05
6 changed files with 38 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
.github/issue_template.md vendored
View File

@@ -1,9 +1,11 @@
<!-- Have you done the following?
* read the Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/PegasysEng/pantheon/blob/master/CODE-OF-CONDUCT.md
* Reproduced the issue in the latest version of the software
* Followed all steps in the debugging wiki: https://github.com/PegasysEng/pantheon/wiki/debugging
* Verified the issue doesn't already exist: https://github.com/search?q=+is%3Aissue+repo%3APegasysEng/Pantheon
Note: Not all sections will apply to all issue types.-->
<!-- Have you done the following? -->
<!-- * read the Code of Conduct? By filing an Issue, you are expected to -->
<!-- comply with it, including treating everyone with respect: -->
<!-- https://github.com/PegasysEng/pantheon/blob/master/CODE-OF-CONDUCT.md -->
<!-- * Reproduced the issue in the latest version of the software -->
<!-- * Read the debugging wiki: https://github.com/PegasysEng/pantheon/wiki/debugging -->
<!-- * Duplicate Issue check: https://github.com/search?q=+is%3Aissue+repo%3APegasysEng/Pantheon -->
<!-- Note: Not all sections will apply to all issue types. -->
### Description
As an [Actor], I want [feature] so that [why].

20
CLA.md
View File

@@ -1,3 +1,19 @@
**TODO:**
Sign the CLA
=============
## Attribution
This page is the step-by-step guide to signing the Consensys AG
Individual Contributor License Agreement.
1. First and foremost, read [the current version of the CLA].
It is written to be as close to plain English as possible.
2. Make an account on [GitHub] if you don't already have one.
3. After creating your first pull request, you will see a merge
pre-requisite requiring to you read and sign the CLA.
If you have any questions, you can reach us on [Gitter].
[Gitter]: https://gitter.im/PegaSysEng/pantheon
[GitHub]: https://github.com/
[the current version of the CLA]: https://gist.github.com/rojotek/978b48a5e8b68836856a8961d6887992

4
CONTRIBUTING.md
View File

@@ -18,7 +18,6 @@ Welcome to the Pantheon repository! The following is a set of guidelines for co
[Style Guides](#style-guides)
* [Git Commit Messages & Pull Request Messages](#git-commit-messages--pull-request-messages)
* [Java Style Guide](#java-code-style-guide)
* [Documentation Style Guide](#documentation-style-guide)
[Issue and Pull Request Labels](#issue-and-pull-request-labels)
@@ -170,6 +169,7 @@ Exceptions:
* Provide a summary on the first line with more details on additional lines as needed
* Reference issues and pull requests liberally
#Issue and Pull Request Labels
#### Type of Issue and Issue State
| Label name | Search Link :mag_right: | Description |
@@ -228,7 +228,7 @@ Exceptions:
[private@pegasys.tech]: mailto:private@pegasys.tech
[Gitter]: https://gitter.im/Pantheon
[Gitter]: https://gitter.im/PegaSysEng/pantheon
[Wiki]: https://github.com/PegaSysEng/pantheon/wiki
[Debugging Wiki]: https://github.com/PegaSysEng/pantheon/wiki/Debugging
[CLA.md]: /CLA.md

3
docs/architecture/java-modules.md
View File

@@ -1,3 +0,0 @@
**TODO:**
## Attribution

2
docs/community/code-reviews.md
View File

@@ -23,4 +23,4 @@ This Document was adapted by the following:
- Kubernetes collab.md, available at [kub collab]
[kub collab]: https://raw.githubusercontent.com/kubernetes/community/master/contributors/devel/collab.md
[Pantheon Gitter]: https://gitter.im/Pantheon
[Pantheon Gitter]: https://gitter.im/PegaSysEng/pantheon

18
docs/community/community-membership.md
View File

@@ -10,10 +10,10 @@ this project.
| Everyone | none | anybody with a belly button
| Member | everyone who contributes - code or otherwise | Pantheon GitHub org member
| Approver | approve accepting contributions | write permissions on master
| Project Manager | management of the project | **TODO:**
| Project Sponsor | contribute developer resources | **TODO:**
| Open Source Circle | OSS support | **TODO:**
| Project Evangelist | promote the project | **TODO:**
| Project Manager | management of the project | PegaSys
| Project Sponsor | contribute developer resources | PegaSys
| Open Source Circle | OSS support | PegaSys
| Project Evangelist | promote the project | PegaSys
| Benevolent Dictator | decision tie-breaker | PegaSys
## Everyone
@@ -88,7 +88,7 @@ Code approvers are members that have signed an ICLA and have been granted additi
## Project Manager
The Project Manager role provides the user with control over management aspects of the project.
**Defined by:** TODO: Where do we document this?
**Defined by:** PegaSys
### Requirements
- Includes all of the requirements of a Member user
@@ -105,7 +105,7 @@ The Project Manager role provides the user with control over management aspects
## Project Sponsor
The Project Sponsor role provides a user with the ability to contribute additional developer resources to the project. Project Sponsors must sign the ICLA.
**Defined by:** TODO: Where do we document this?
**Defined by:** PegaSys
### Requirements
- Signed ICLA, as described in [CLA.md]
@@ -117,7 +117,7 @@ The Project Sponsor role provides a user with the ability to contribute addition
## Open Source Circle
The Open Source Circle is a group that provides open source software support to projects.
**Defined by:** **TODO:** Where do we document this?
**Defined by:** PegaSys
### Requirements
- Includes all of the requirements of a Member user
@@ -132,7 +132,7 @@ The Open Source Circle is a group that provides open source software support to
## Project Evangelist
The Project Evangelist role is for those who wish to promote the project to the outside world, but not actively contribute to it.
**Defined by:** TODO: Where do we document this?
**Defined by:** PegaSys
### Requirements
- Includes all of the requirements of a Member user
@@ -169,5 +169,5 @@ This document is adapted from the following sources:
[New contributors]: /CONTRIBUTING.md
[two-factor authentication]: https://help.github.com/articles/about-two-factor-authentication
[pantheon-dev@pegasys.tech]: mailto:pantheon-dev@pegasys.tech
[Pantheon Gitter]: https://gitter.im/Pantheon
[Pantheon Gitter]: https://gitter.im/PegaSysEng/pantheon
[Pantheon Wiki]: https://github.com/PegaSysEng/pantheon/wiki