Submit a PR that adds community standard docs

Table of contents

• 1. Fork the Git repository
• 2. Clone the forked repository
• 3. Create a new docs/community-standards branch
• 4. Add the boilerplate templates to the root directory
• 5. Add the documents to Git
• 6. Commit and stage the documents
• 7. Push the documents to origin
• 8. Submit a pull request (PR)
  • 8.1. Title
  • 8.2. Description

1. Fork the Git repository

If you have write access to the repository, you can clone the repository, instead. Otherwise, fork the repository of interest to your personal organization (in GitHub or BitBucket).

2. Clone the forked repository

git clone https://hostname.com/path/to/repo.git

cd repo/

3. Create a new docs/community-standards branch

git checkout -b docs/community-standards

4. Add the boilerplate templates to the root directory

mkdir -p docs/img/

cp /path/to/generator-community-repo.wiki/docs/img/ ./docs/img/

cp /path/to/generator-community-repo.wiki/*.md ./

5. Add the documents to Git

git add .

6. Commit and stage the documents

git commit -m "docs(community-repo): add inner/open source templates

Build a community that encourages people to use, contribute to, and evangelize
your product with these recommended community standards
(https://opensource.guide/):

1. README.md: The repo's home page with _consumption_ instructions
2. CONTRIBUTING.md: The instruction manual for _contributions_
3. CODE_OF_CONDUCT.md: Instructions for community _behavior_
4. LICENSE: : Mitigate consumer/contributor legal risks (**not included**)

* **TODO:** Replace README.md and CONTRIBUTING.md's placeholder text with your product delivery team's custom instructions.
* **TODO:** Replace the following string in all documents with your product's name:
     product-name

"

7. Push the documents to origin

git push origin docs/community-standards

8. Submit a pull request (PR)

8.1. Title

docs(community-repo): add inner/open source templates

8.2. Description

Add the following Git comment to your PR.

Build a community that encourages people to use, contribute to, and evangelize your product with these recommended community standards (https://opensource.guide/):

1. README.md: The repo's home page with _consumption_ instructions
2. CONTRIBUTING.md: The instruction manual for _contributions_
3. CODE_OF_CONDUCT.md: Instructions for community _behavior_
4. LICENSE: : Mitigate consumer/contributor legal risks (**not included**)

* **TODO:** Replace README.md and CONTRIBUTING.md's placeholder text with your product delivery team's custom instructions.
* **TODO:** Replace the following string in all documents with your product's name:
     product-name

## Description of changes

1. Add [GitHub's recommended community standards](https://opensource.guide/) documents in order to encourage people to use, contribute to, and evangelize our products (as well as return meaningful search results).

2. Include an _optional_ CHANGELOG.md  to encourage the team to [consider commit message conventions that enable automated CHANGELOG generation and updates](https://github.com/conventional-changelog/standard-version).

3. Include sample MIT open source LICENSE: , which is not required for inner source products, but a [crucial consideration should you ever decide to open source your product](https://opensource.guide/legal/).

### Associated issue(s)

__N/A__. Just a friendly helping hand from the VZ Inner and Open Source Program 👨‍👧‍👦 .

- [ ] The acceptance criteria for all associated issues have been completed, tested, and validated.

### PR check-list

> **✅  Please review and check the appropriate items.**

#### 1. Next steps

##### 1.1. README.md

- [ ] The README's content provides usage instructions.

- [ ] The README describes our team's Git collaboration model and how to contribute.

##### 1.2. CONTRIBUTING.md

- [ ] The CONTRIBUTING guidelines provide detailed, unambiguous instructions that allow anyone in Verizon to contribute to your product and community.