djpbessems/ContainerImage.Pinniped
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #140 from mattmoyer/shuffle-contrib-docs

Browse Source 
Rename the CoC and contributor guide to the names GitHub recognizes.
This commit is contained in:
Matt Moyer 2020-10-05 11:24:59 -05:00 committed by GitHub
commit 7eed7ba19a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/pull_request_template.md vendored
View File

@ -1,6 +1,6 @@
Thank you for submitting a pull request for Pinniped! Thank you for submitting a pull request for Pinniped!
Before submitting, please see the guidelines in doc/contributing.md in this repo. Before submitting, please see the guidelines in CONTRIBUTING.md in this repo.
Please note that a project maintainer will need to review and provide an Please note that a project maintainer will need to review and provide an
initial approval on the PR to cause CI tests to automatically start. initial approval on the PR to cause CI tests to automatically start.
@ -8,7 +8,7 @@ Also note that if you push additional commits to the PR, those commits
will need another initial approval before CI will pick them up. will need another initial approval before CI will pick them up.
Reminder: Did you remember to run all the linter, unit tests, and integration tests Reminder: Did you remember to run all the linter, unit tests, and integration tests
described in doc/contributing.md on your branch before submitting this PR? described in CONTRIBUTING.md on your branch before submitting this PR?
Below is a template to help you describe your PR. Below is a template to help you describe your PR.

0
doc/code_of_conduct.md → CODE_OF_CONDUCT.md
View File

12
doc/contributing.md → CONTRIBUTING.md
View File

@ -2,8 +2,8 @@
Contributions to Pinniped are welcome. Here are some things to help you get started. Contributions to Pinniped are welcome. Here are some things to help you get started.
1. Please see the [Code of Conduct](code_of_conduct.md). 1. Please see the [Code of Conduct](./CODE_OF_CONDUCT.md).
1. Learn about the [scope](scope.md) of the project. 1. Learn about the [scope](doc/scope.md) of the project.
1. Coming soon: details about how to legally contribute to the project, including CLA/DCO details. 1. Coming soon: details about how to legally contribute to the project, including CLA/DCO details.
1. See below for how to [file a bug report](#bugs). 1. See below for how to [file a bug report](#bugs).
1. See below for how to [suggest a feature](#features). 1. See below for how to [suggest a feature](#features).
@ -13,7 +13,7 @@ Contributions to Pinniped are welcome. Here are some things to help you get star
## Meeting with the Maintainers ## Meeting with the Maintainers
The maintainers aspire to hold a video conference every other week with the Pinniped community. The maintainers aspire to hold a video conference every other week with the Pinniped community.
Any community member may request to add topics to the agenda by contacting a [maintainer](../MAINTAINERS.md) Any community member may request to add topics to the agenda by contacting a [maintainer](MAINTAINERS.md)
in advance, or by attending and raising the topic during time remaining after the agenda is covered. in advance, or by attending and raising the topic during time remaining after the agenda is covered.
Typical agenda items include topics regarding the roadmap, feature requests, bug reports, pull requests, etc. Typical agenda items include topics regarding the roadmap, feature requests, bug reports, pull requests, etc.
A [public document](https://docs.google.com/document/d/1qYA35wZV-6bxcH5375vOnIGkNBo7e4OROgsV4Sj8WjQ) A [public document](https://docs.google.com/document/d/1qYA35wZV-6bxcH5375vOnIGkNBo7e4OROgsV4Sj8WjQ)
@ -69,7 +69,7 @@ tracker.
## Building ## Building
The [Dockerfile](../Dockerfile) at the root of the repo can be used to build and The [Dockerfile](Dockerfile) at the root of the repo can be used to build and
package the code. After making a change to the code, rebuild the docker image with the following command. package the code. After making a change to the code, rebuild the docker image with the following command.
```bash ```bash
@ -103,7 +103,7 @@ The `./hack/prepare-for-integration-tests.sh` script will create a local
### Observing Tests on the Continuous Integration Environment ### Observing Tests on the Continuous Integration Environment
CI will not be triggered on a pull request until the pull request is reviewed and CI will not be triggered on a pull request until the pull request is reviewed and
approved for CI by a project [maintainer](../MAINTAINERS.md). Once CI is triggered, approved for CI by a project [maintainer](MAINTAINERS.md). Once CI is triggered,
the progress and results will appear on the Github page for that the progress and results will appear on the Github page for that
[pull request](https://github.com/vmware-tanzu/pinniped/pulls) as checks. Links [pull request](https://github.com/vmware-tanzu/pinniped/pulls) as checks. Links
will appear to view the details of each check. will appear to view the details of each check.
@ -129,4 +129,4 @@ pre-commit installed at .git/hooks/pre-commit
Regular contributors who are active in the Pinniped community and who have contributed at least several Regular contributors who are active in the Pinniped community and who have contributed at least several
significant pull requests may be considered for promotion to become a maintainer upon request. Please significant pull requests may be considered for promotion to become a maintainer upon request. Please
contact an existing [maintainer](../MAINTAINERS.md) if you would like to be considered. contact an existing [maintainer](MAINTAINERS.md) if you would like to be considered.

2
README.md
View File

@ -42,7 +42,7 @@ Got a question, comment, or idea? Please don't hesitate to reach out via the Git
## Contributions ## Contributions
Contributions are welcome. Before contributing, please see the [contributing guide](doc/contributing.md). Contributions are welcome. Before contributing, please see the [contributing guide](CONTRIBUTING.md).
## Reporting Security Vulnerabilities ## Reporting Security Vulnerabilities

2
doc/scope.md
View File

@ -29,4 +29,4 @@ The following items are out of scope for the Pinniped project.
More details coming soon! More details coming soon!
For more details on proposing features and bugs, check out our For more details on proposing features and bugs, check out our
[contributing](contributing.md) doc. [contributing](../CONTRIBUTING.md) doc.