Congrats, project leads! You got a new project to grow!
This stub is meant to help you form a strong community around your work. It's yours to adapt, and may diverge from this initial structure. Just keep the files seeded in this repo, and the rest is yours to evolve!
Orient users to the project here. This is a good place to start with an assumption that the user knows very little - so start with the Big Picture and show how this project fits into it.
Then maybe a dive into what this project does.
Diagrams and other visuals are helpful here. Perhaps code snippets showing usage.
Project leads should complete, alongside this README:
- CODEOWNERS - set project lead(s)
- CONTRIBUTING.md - Fill out how to: install prereqs, build, test, run, access CI, chat, discuss, file issues
- Bug-report.md - Fill out
Assigneesadd codeowners @names - config.yml - remove "(/add your discord channel..)" and replace the url with your Discord channel if applicable
The other files in this template repo may be used as-is:
| Resource | Description |
|---|---|
| CODEOWNERS | Outlines the project lead(s) |
| CODE_OF_CONDUCT.md | Expected behavior for project contributors, promoting a welcoming environment |
| CONTRIBUTING.md | Developer guide to build, test, run, access CI, chat, discuss, file issues |
| GOVERNANCE.md | Project governance |
| LICENSE | Apache License, Version 2.0 |