Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation around various project processes #1136

Closed
mvalliath opened this issue Feb 4, 2023 · 1 comment · Fixed by #1185, #1216 or #1220
Closed

Add documentation around various project processes #1136

mvalliath opened this issue Feb 4, 2023 · 1 comment · Fixed by #1185, #1216 or #1220
Labels
cnb-donation Required for the project to be donated to CNB community organization documentation

Comments

@mvalliath
Copy link

We should add documentation around various project processes as part of top-level kpack repo:

  • DEVELOPMENT.md - prerequisites for developing kpack, running tests, any associated tasks (see https://github.com/buildpacks/lifecycle/blob/main/DEVELOPMENT.md for example)
  • SECURITY.md - our process around reporting security issues
  • CONTRIBUTING.md - general contributing standards, links to helpful background reading, that links out to DEVELOPMENT.md, SECURITY.md (See the Lifecycle CONTRIBUTORS.md for an example)
  • GOVERNANCE.md - our policies around governance & roles we currently have (see see Buildpacks community GOVERNANCE.md for an example

We should include the following in one of the above README's or in the other README's we have (RELEASE.md, VERSIONING.md, etc.)

  • Our process around source control
  • Our build process
  • Our process around issue tracking
  • Our process around onboarding & off-boarding contributors and maintainers
@mvalliath
Copy link
Author

We should work on all Contributing, Development, Versioning, and Release first.

@jjbustamante jjbustamante added documentation cnb-donation Required for the project to be donated to CNB community organization labels Mar 22, 2023
This was referenced May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cnb-donation Required for the project to be donated to CNB community organization documentation
Projects
None yet
2 participants