Add CONTRIBUTING.md #85
Conversation
|
Per https://github.com/github/open-source-handbook/issues/81, checks are failing but I think we're ok, right? |
|
|
||
| * **Approachability:** Don't assume reader has prior knowledge | ||
| * **Brevity:** Keep it simple, link to outside content for deeper dives | ||
| * **Curation:** Amplify community best practices vs. any individual's POV |
If we end up serving the content from github.com/open-source we may become more restrictive with design, but as long as it's a stand-alone jekyll site, I'm actually curious to see what all people will contribute. What do you think? @mlinksva The current license doesn't say anything about the styles and design. Thoughts?
They shouldn't have to modify any tests. They may need to pay attention to test failures (after switching to Travis CI - #87). If we get spelling (#63) or any other more strict tests, we may need people to add new terms to a dictionary.
I don't think so.
👍 for being explicit about keeping communication public. I'll comment on specific lines below.
Looks like it's fixed now. |
|
CSS falls under code I'd think. |
|
|
||
| ## Goals of this project | ||
|
|
||
| We created this Handbook for individuals, communities and companies that want to successfully run and maintain an open source project. The content was originally created and curated by GitHub, along with input from outside community reviewers, but it is not specific to GitHub products. |
There was a problem hiding this comment.
communities and companies -> communities, and companies
| * **Brevity:** Keep it simple, link to outside content for deeper dives | ||
| * **Curation:** Amplify community best practices vs. any individual's POV | ||
|
|
||
| This Handbook is a jumping off point for people who want to familiarize themselves with running an open source project. It should give readers enough information to get started, but it doesn't attempt to answer everything in detail. |
There was a problem hiding this comment.
This Handbook is a jumping off point for people who want to familiarize themselves with running an open source project.
Is there a simpler way to say this? Maybe?
This Handbook is a jumping off point for people who want to learn how to run an open source project.
|
|
||
| This Handbook is a jumping off point for people who want to familiarize themselves with running an open source project. It should give readers enough information to get started, but it doesn't attempt to answer everything in detail. | ||
|
|
||
| This Handbook also aggregates community best practices, *not* what GitHub (or any other individual or entity) thinks is best. Therefore, we try to use examples and quotations from others to illustrate our points. Many sections also link to "Further Reading" at the end, to surface relevant writing and perspectives that lives elsewhere on the web. |
|
|
||
| Interested in making a contribution? Read on! | ||
|
|
||
| (should we call out anything we're NOT looking for here? would we accept design or code contributions?) |
There was a problem hiding this comment.
Your Right we hiring nothing only just both, please linked you one white a strong develop and engineering skills. I have two autorisiert.
Copilot Pro and Jira. And we have a one Helper to. For Command Building. Tomorrow I'll try Chat GpT4 and somehow i need the Crook"3. What are you thinking about?
|
|
||
| Before we get started, here are a few things we expect from you (and that you should expect from others): | ||
|
|
||
| * Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done". Try to listen to others rather than convince them that your way is correct. |
There was a problem hiding this comment.
"how open source is done". -> "how open source is done."
|
|
||
| ## Bug reports and security disclosures | ||
|
|
||
| (do we need to include for this project?) |
There was a problem hiding this comment.
I defer to the rest of the team.
|
|
||
| There is also a mailing list for regular updates and discussion (link to mailing list) | ||
|
|
||
| Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Not only will you stress them out, but keeping communication public means everybody can benefit and learn from the conversation. |
There was a problem hiding this comment.
Not only will you stress them out
Do we need this? It's humanizing but also starting to sound like a burden. Could we just leave it at "keeping communication public..."
First pass on writing up CONTRIBUTING.md, which should 1) explain the goals of this project and 2) help people figure out how to contribute.
Couple of things I'd like input on before merging:
cc @bkeepers for qs 1-4
@stephbwills for q4 and overall input on tone/friendliness