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

Document Contributing section #5281

Open
10 tasks
annasong20 opened this issue Aug 21, 2023 · 2 comments
Open
10 tasks

Document Contributing section #5281

annasong20 opened this issue Aug 21, 2023 · 2 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@annasong20
Copy link
Contributor

annasong20 commented Aug 21, 2023

This is a sub-task of #4338.

Complete the Contribute section of our site-in-progress. In addition to the existing content migration listed in this spreadsheet, we want to add new content to this page so that it comprehensively documents how to contribute to Kustomize. Note also the Notes on the Docs project.

I brainstormed a list of relevant topics below. Feel free to comment on this issue if you'd like to see something that isn't here. Note the Contributing content already on the site; feel free to improve on it. Many of these topics may also already be documented in Markdown within the repo, in which case if the content is more technical, it should stay in the repo and the site can link to it. Otherwise, the content should be migrated to the site. The content of these docs are very much open to the assignee; the goal is to make them as readable as possible.

  • Contributing home page
  • Subscribe to SIG CLI + Kustomize communications. Check if existing content is complete.
  • Setup local dev environment. Check if macOS guide is complete. Maybe move the installation via source code section into the Contribute section and link to it instead.
  • Run local workflows. This is essentially Create contributor guide #5199. This also involves any improvements to ARCHITECTURE.md.
  • File and assign issues. Check if existing content is complete. Most of the issue-filing instructions should live in the issue template. The docs should only have high-level instructions on how to proceed. This page should also explain how contributors go about choosing issues to work on. It involves highlighting the relevant issue labels, particularly good-first-issue, the /assign Prow command, etc. Note that some of this may be documented in upstream Kubernetes, in which case we should link to those docs.
  • Contribute features. Check if existing content is complete.
  • Follow upstream contribution best practices. This involves how to write commit messages and PR descriptions as well as the ideal PR size, etc.; you can reference these Kubernetes docs.
  • Contribute to documentation. In addition to the links in the spreadsheet, you may also find the site README.md helpful.

We've never documented the flows below, but I think they'd clarify ambiguities and fun to learn!

  • Interact with CI. Document the presubmit tests that guard PRs. This probably involves linking to the test-infra repo; for example, these are relevant links to configurations and presubmits. This also involves documenting Prow commands to interact with PRs. Again, some content may be documented in upstream Kubernetes, in which case we should link to it.
  • Understand CD workflow. The release process is documented here. The simplest solution would be to link to it, but feel free to understand and improve on it!
@k8s-ci-robot k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 21, 2023
@annasong20
Copy link
Contributor Author

For anyone who picks this up, you can assign yourself to #5199 as well. I don't believe the contributor is actively working on it.

@annasong20
Copy link
Contributor Author

/kind documentation
/triage accepted

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Development

No branches or pull requests

2 participants