generated from IBM/repo-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Chris Butler <chris@thebutlers.me>
- Loading branch information
Showing
4 changed files
with
3 additions
and
96 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,5 @@ | ||
| <!-- This should be the location of the title of the repository, normally the short name --> | ||
| # repo-template | ||
| # compliance-trestle-fedramp | ||
|
|
||
| <!-- Build Status, is a great thing to have at the top of your repository, it shows that you take your CI/CD as first class citizens --> | ||
| <!-- [](https://travis-ci.org/jjasghar/ibm-cloud-cli) --> | ||
| A plugin for [compliance-trestle](https://github.com/IBM/compliance-trestle) to provide functionality specifically for FedRAMP. | ||
|
|
||
| <!-- Not always needed, but a scope helps the user understand in a short sentance like below, why this repo exists --> | ||
| ## Scope | ||
|
|
||
| The purpose of this project is to provide a template for new open source repositories. | ||
|
|
||
| <!-- A more detailed Usage or detailed explaination of the repository here --> | ||
| ## Usage | ||
|
|
||
| This repository contains some example best practices for open source repositories: | ||
|
|
||
| * [LICENSE](LICENSE) | ||
| * [README.md](README.md) | ||
| * [CONTRIBUTING.md](CONTRIBUTING.md) | ||
| * [MAINTAINERS.md](MAINTAINERS.md) | ||
| <!-- A Changelog allows you to track major changes and things that happen, https://github.com/github-changelog-generator/github-changelog-generator can help automate the process --> | ||
| * [CHANGELOG.md](CHANGELOG.md) | ||
|
|
||
| > These are optional | ||
| <!-- The following are OPTIONAL, but strongly suggested to have in your repository. --> | ||
| * [dco.yml](.github/dco.yml) - This enables DCO bot for you, please take a look https://github.com/probot/dco for more details. | ||
| * [travis.yml](.travis.yml) - This is a example `.travis.yml`, please take a look https://docs.travis-ci.com/user/tutorial/ for more details. | ||
|
|
||
| These may be copied into a new or existing project to make it easier for developers not on a project team to collaborate. | ||
|
|
||
| <!-- A notes section is useful for anything that isn't covered in the Usage or Scope. Like what we have below. --> | ||
| ## Notes | ||
|
|
||
| **NOTE: While this boilerplate project uses the Apache 2.0 license, when | ||
| establishing a new repo using this template, please use the | ||
| license that was approved for your project.** | ||
|
|
||
| **NOTE: This repository has been configured with the [DCO bot](https://github.com/probot/dco). | ||
| When you set up a new repository that uses the Apache license, you should | ||
| use the DCO to manage contributions. The DCO bot will help enforce that. | ||
| Please contact one of the IBM GH Org stewards.** | ||
|
|
||
| <!-- Questions can be useful but optional, this gives you a place to say, "This is how to contact this project maintainers or create PRs --> | ||
| If you have any questions or issues you can create a new [issue here][issues]. | ||
|
|
||
| Pull requests are very welcome! Make sure your patches are well tested. | ||
| Ideally create a topic branch for every separate change you make. For | ||
| example: | ||
|
|
||
| 1. Fork the repo | ||
| 2. Create your feature branch (`git checkout -b my-new-feature`) | ||
| 3. Commit your changes (`git commit -am 'Added some feature'`) | ||
| 4. Push to the branch (`git push origin my-new-feature`) | ||
| 5. Create new Pull Request | ||
|
|
||
| ## License | ||
|
|
||
| All source files must include a Copyright and License header. The SPDX license header is | ||
| preferred because it can be easily scanned. | ||
|
|
||
| If you would like to see the detailed LICENSE click [here](LICENSE). | ||
|
|
||
| ```text | ||
| # | ||
| # Copyright 2020- IBM Inc. All rights reserved | ||
| # SPDX-License-Identifier: Apache2.0 | ||
| # | ||
| ``` | ||
| ## Authors | ||
|
|
||
| Optionally, you may include a list of authors, though this is redundant with the built-in | ||
| GitHub list of contributors. | ||
|
|
||
| - Author: New OpenSource IBMer <new-opensource-ibmer@ibm.com> | ||
|
|
||
| [issues]: https://github.com/IBM/repo-template/issues/new | ||
| Currently a work in progress please see the compliance-trestle project for more details. |