[NC-1773] Minor OSS documentation tweaks. (#122)

Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
pull/2/head
mark-terry 6 years ago committed by GitHub
parent 41fbe72729
commit 454a787a8d
  1. 2
      .github/issue_template.md
  2. 8
      .github/pull_request_template.md
  3. 10
      CONTRIBUTING.md
  4. 2
      GOVERNANCE.md
  5. 4
      docs/community/code-reviews.md
  6. 4
      docs/community/community-membership.md

@ -5,7 +5,7 @@ Have you read the Code of Conduct? By filing an Issue, you are expected to compl
### Prerequisites ### Prerequisites
* [ ] Put an X between the brackets on this line if you have done all of the following: * [] Put an X between the brackets on this line if you have done all of the following:
* Reproduced the issue in the latest version of the software * Reproduced the issue in the latest version of the software
* Followed all steps in the debugging wiki: https://github.com/PegasysEng/pantheon/wiki/debugging * 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 * Verified the issue doesn't already exist: https://github.com/search?q=+is%3Aissue+repo%3APegasysEng/Pantheon

@ -20,10 +20,10 @@ Fixes #
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Docs change / refactoring / dependency upgrade - [] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue) - [] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality) - [] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change) - [] Breaking change (fix or feature that would cause existing functionality to change)
## Release note ## Release note
<!-- Write your release note: <!-- Write your release note:

@ -19,7 +19,7 @@ Before You start
* [Pull Requests](#pull-requests) * [Pull Requests](#pull-requests)
* [Code Reviews] * [Code Reviews]
[Style Guides](#Style-Guides) [Style Guides](#style-guides)
* [Git Commit Messages & Pull Request Messages](#git-commit-messages--pull-request-messages) * [Git Commit Messages & Pull Request Messages](#git-commit-messages--pull-request-messages)
* [Java Style Guide](#java-code-style-guide) * [Java Style Guide](#java-code-style-guide)
* [Documentation Style Guide](#documentation-style-guide) * [Documentation Style Guide](#documentation-style-guide)
@ -73,8 +73,8 @@ Provide more context by answering these questions:
Include details about your configuration and environment: Include details about your configuration and environment:
* **Which version of the software are you using?** You can get the exact version by running `pantheon -v` in your terminal. * **Which version of the software are you using?** You can get the exact version by running `pantheon -v` in your terminal.
* **What OS & Version are you running * **What OS & Version are you running?**
* **For linux, What Kernel are you running? You can get the exact version by running `uname -a` in your terminal. * **For Linux - What kernel are you running?** You can get the exact version by running `uname -a` in your terminal.
* **Are you running in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest? * **Are you running in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
* **Are you running in a docker container?** If so, what version of docker? * **Are you running in a docker container?** If so, what version of docker?
* **Are you running in a a Cloud?** If so, which one, and what type/size of VM is it? * **Are you running in a a Cloud?** If so, which one, and what type/size of VM is it?
@ -147,7 +147,7 @@ Please follow these steps to have your contribution considered by the approvers:
4. Follow the [styleguides](#Style Guides) 4. Follow the [styleguides](#Style Guides)
5. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details> 5. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. Please refer to [code-reviews.md]. While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. Please refer to [Code Reviews].
# Style Guides # Style Guides
## Java Code Style Guide ## Java Code Style Guide
@ -198,7 +198,7 @@ Exceptions:
This section lists the labels we use to help us track and manage issues and pull requests. This section lists the labels we use to help us track and manage issues and pull requests.
[GitHub search](https://help.github.com/articles/searching-issues/) makes it easy to use labels for finding groups of issues or pull requests you're interested in. [GitHub search](https://help.github.com/articles/searching-issues-and-pull-requests/) makes it easy to use labels for finding groups of issues or pull requests you're interested in.
The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group. The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.

@ -1,5 +1,3 @@
This is a Work in Progress, documenting approximately how we have been operating up to this point.
# Overview # Overview
This project is led by a benevolent dictator (PegaSys) and managed by the community. That is, the community actively contributes to the day-to-day maintenance of the project, but the general strategic line is drawn by the benevolent dictator. In case of disagreement, they have the last word. It is the benevolent dictator’s job to resolve disputes within the community and to ensure that the project is able to progress in a coordinated way. In turn, it is the community’s job to guide the decisions of the benevolent dictator through active engagement and contribution. This project is led by a benevolent dictator (PegaSys) and managed by the community. That is, the community actively contributes to the day-to-day maintenance of the project, but the general strategic line is drawn by the benevolent dictator. In case of disagreement, they have the last word. It is the benevolent dictator’s job to resolve disputes within the community and to ensure that the project is able to progress in a coordinated way. In turn, it is the community’s job to guide the decisions of the benevolent dictator through active engagement and contribution.

@ -17,10 +17,6 @@ reasonable timeframe).
If a PR has gone 2 work days without an approver emerging, please ask on [Pantheon Gitter] If a PR has gone 2 work days without an approver emerging, please ask on [Pantheon Gitter]
Except for rare cases, such as trivial changes (e.g. typos, comments) or
emergencies (e.g. broken builds), approvers should not merge their own
changes without another approver providing the code review.
## Attribution ## Attribution
This Document was adapted by the following: This Document was adapted by the following:

@ -44,7 +44,7 @@ issues and PRs assigned to them.
- Have made multiple contributions to the project or community. Contribution may include, but is not limited to: - Have made multiple contributions to the project or community. Contribution may include, but is not limited to:
- Authoring or reviewing PRs on GitHub - Authoring or reviewing PRs on GitHub
- Filing or commenting on issues on GitHub - Filing or commenting on issues on GitHub
- Contributing community discussions (e.g. meetings, Slack, email discussion forums, Stack Overflow) - Contributing to community discussions (e.g. meetings, Slack, email discussion forums, Stack Overflow)
- Subscribed to [pantheon-dev@pegasys.tech] - Subscribed to [pantheon-dev@pegasys.tech]
- Joined [Pantheon Gitter] - Joined [Pantheon Gitter]
- Browsed [Pantheon Wiki] - Browsed [Pantheon Wiki]
@ -127,7 +127,7 @@ The Open Source Circle is a group that provides open source software support to
### Responsibilities and privileges ### Responsibilities and privileges
- Includes all of the responsibilities and privileges of a Project Sponsor - Includes all of the responsibilities and privileges of a Project Sponsor
- Ability to archive the project - Ability to archive the project
- manage the CLA - Manage the CLA
- Conduct legal reviews - Conduct legal reviews
## Project Evangelist ## Project Evangelist

Loading…
Cancel
Save