https://github.com/sunstonesecure-robert/sledgehammer
https://github.com/sunstonesecure-robert/sledgehammer
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sunstonesecure-robert/sledgehammer
- Owner: sunstonesecure-robert
- License: apache-2.0
- Created: 2023-01-04T18:24:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-22T04:36:50.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T03:41:58.757Z (6 months ago)
- Size: 270 KB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README-template.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Governance: GOVERNANCE-elections.md
Awesome Lists containing this project
- awesome-oscal - Project SledgeHammer
README
# README
The is a README template for CNCF projects. Please start by renaming this to
README.md and deleting everything up to and including the "template begins here"
comment in this markdown file.
This is a template document for CNCF projects that requires editing
before it is ready to use. Read the markdown comments, ``, for
additional guidance. The raw markdown uses `TODO` to identify areas that
require customization. Replace [TODO: PROJECTNAME] with the name of your project.
# Welcome to the [TODO:Projectname] Project!
[TODO: PROJECTNAME] is a [TODO: Type of Tool] that [TODO: Functions it
performs]. [TODO: Reasons why these are needed and valuable]. [TODO:
Implementation, strategy and architecture].
[TODO: Additional paragraph describing your project (optional)]
[TODO: PROJECTNAME] is hosted by the [Cloud Native Computing Foundation (CNCF)](https://cncf.io).
## Getting Started
## Contributing
Our project welcomes contributions from any member of our community. To get
started contributing, please see our [Contributor Guide](TODO: Link to
CONTRIBUTING.md).
## Scope
### In Scope
[TODO: PROJECTNAME] is intended to [TODO: Core functionality]. As such, the
project will implement or has implemented:
* [TODO: High-level Item 1]
* [TODO: High-level Item 2]
* [TODO: High-level Item 3]
### Out of Scope
[TODO: PROJECTNAME] will be used in a cloud native environment with other
tools. The following specific functionality will therefore not be incorporated:
* [TODO: Excluded function 1]
* [TODO: Excluded function 2]
[TODO: PROJECTNAME] implements [TODO: List of major features, existing or
planned], through [TODO: Implementation
requirements/language/architecture/etc.]. It will not cover [TODO: short list
of excluded items]
## Communications
[TODO: Details (with links) to meetings, mailing lists, Slack, and any other communication channels]
* User Mailing List:
* Developer Mailing List:
* Slack Channel:
* Public Meeting Schedule and Links:
* Social Media:
* Other Channel(s), If Any:
## Resources
[TODO: Add links to other helpful information (roadmap, docs, website, etc.)]
## License
This project is licensed under [TODO: Add name of license and link to your LICENSE file]
## Conduct
We follow the CNCF Code of Conduct [TODO: Insert link to your CODE_OF_CONDUCT.md file].