search

Azure / draft-classic

A tool for developers to create cloud-native applications on Kubernetes.
https://draft.sh
MIT License
3.92k stars 395 forks source link

CONTRIBUTING.md guideline file missing #793

Closed zdeptawa closed 6 years ago

zdeptawa commented 6 years ago

I wasn't able to find a CONTRIBUTING.md file with contributing guidelines for Draft - I've usually seen them at the root of repositories. There is a 'contributing' folder in the draft repo, but no real contributing guidelines that I've found. Could we look at adding something?

bacongobbler commented 6 years ago

Yes that sounds like a great idea. I've actually started taking a stab at restructuring the documentation into a website in #770 that centralizes around a few core concepts including a contributing guide (governance, communication channels, deprecation policies, security policies, backwards compatibility policy etc). We can reference to that in CONTRIBUTING.md once it's done. For now @raravena80's PR in #797 should be a good starting place to work on how we wanna shape the CONTRIBUTING docs.

Does that sound like something you'd be interested in influencing? :)

Right now the only reference we make to contributing to Draft is under https://github.com/Azure/draft#contributing, which isn't much to figure out how to start contributing.

zdeptawa commented 6 years ago

@bacongobbler I'd love to help however I can! I see you have #801 open now to at least knock this issue out. Should we close this issue and follow up there? Thanks for your help here!

sam-doordash commented 6 years ago

This needs to be closed @bacongobbler - #801 sorted it.

bacongobbler commented 6 years ago

We generally close issues once the PR has been merged; that way if we need to close PRs in favour of another or back it out we can continue to track it here. Makes it easier to triage :)

bacongobbler commented 6 years ago

But yes once #801 is merged this issue will automatically close. :)