Add Best Practices guide to contributing to Kubernetes

kubernetes / contributor-site

Code for kubernetes.dev

https://www.kubernetes.dev

Apache License 2.0

67 stars 149 forks source link

Add Best Practices guide to contributing to Kubernetes #325

Closed nitishfy closed 1 year ago

nitishfy commented 2 years ago

This is a Feature Request

Although experienced developers and new folks are contributing to the K8s project. It can be beneficial especially to all the new folks where we can include a page with the motive of "Best practices in the community" depicting what are the things that should be followed and avoided. For eg. Don't spam, Try before asking, Don't work on an issue that has already been assigned, Be patient, etc.

Why is this needed

This page can really be helpful to all the new folks who are looking forward to contributing to the K8s project.

Comments:

If this issue gets accepted, I'd love to work on this issue since I've written a blog on it as well.

deveshgoyal1000 commented 2 years ago

It is already there in contributors guide and code of conduct.

nitishfy commented 2 years ago

@deveshgoyal1000 I feel like the document is good but it can be enhanced to make it look better by adding the above points mentioned.

mrbobbytables commented 2 years ago

I agree with @deveshgoyal1000 we have most of this documented in the guide and the cheatsheet. We are also adding a "new contributor course" that will take people through the processes step by step based off the new contributor workshops that we used to run at in person events.

nitishfy commented 2 years ago

@mrbobbytables May I know what topics does the following course covers?

k8s-triage-robot commented 1 year ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

nitishfy commented 1 year ago

/close

k8s-ci-robot commented 1 year ago

@NitishKumar06: Closing this issue.

In response to [this](https://github.com/kubernetes/contributor-site/issues/325#issuecomment-1310279583): >/close > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.