Initial suggestion for contribution guidelines #4353
Conversation
|
We should also add an issue template for PRs and Issues. |
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as |
There was a problem hiding this comment.
I'd like to integrate wording from our MAGFest CoC here, which I think is better-written (specifically, the harassment section). I mentioned linking to it but actually the codebase CoC should probably be separate since it's not just MAGFest using it.
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be |
There was a problem hiding this comment.
We should think about the ways in which code-community incidents interact with event safety/security departments and specify those interactions here. Off the top of my head, harassment that happens at or is directly related to an event (e.g., telling someone that their PR was so bad you're going to kick them in the shins when you see them next MAGFest) should probably still go to that event's safety/HR department.
| **Community Impact**: A violation through a single incident or series | ||
| of actions. | ||
|
|
||
| **Consequence**: A warning with consequences for continued behavior. No |
There was a problem hiding this comment.
I'd like to clarify the language here a bit and possibly make it a bit more flexible wrt what we will require of you when you are warned. How does SAFE handle stuff like this? Is it better that all warnings require a period of no-contact?
| All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 | ||
|
|
||
| > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: | ||
| > - Star the project |
There was a problem hiding this comment.
We probably want to update this list to actions that suit us a bit better, though I'm coming up blank on examples. Let's at least get rid of the reference to X/Twitter.
|
|
||
| ## I Have a Question | ||
|
|
||
| > If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/magfest/ubersystem/tree/main/docs). |
There was a problem hiding this comment.
We might want to rework this section a bit... I'd rather get questions via Slack than via GitHub Issues.
| ## I Want To Contribute | ||
|
|
||
| > ### Legal Notice <!-- omit in toc --> | ||
| > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. |
There was a problem hiding this comment.
This is good, but let's clarify a bit more what that means for AI-generated code in particular. Here's what I'm thinking:
- You agree that when using automated tools to help write code, including boilerplate generators, linters, and LLM/autocomplete algorithms, you have personally verified all output of these tools, line by line, as working and free of major security, quality, and copyright issues
- You agree that any privileged or private information you have access to in the course of your contributions will be treated with extreme care and will not be posted publicly; this includes not providing this information to any LLM-based tools like CoPilot and ChatGPT
| - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) | ||
| - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. | ||
| - Possibly your input and the output | ||
| - Can you reliably reproduce the issue? And can you also reproduce it with older versions? |
There was a problem hiding this comment.
We can cut "And can you also reproduce it with older versions?"
| <!-- omit in toc --> | ||
| #### Before Submitting a Bug Report | ||
|
|
||
| A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. |
There was a problem hiding this comment.
This section is very much geared towards code contributors -- that's fine, but it should note that explicitly so we don't have department heads trying to reproduce a bug on last year's server or anything.
| #### Before Submitting an Enhancement | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - Read the [documentation](https://github.com/magfest/ubersystem/tree/main/docs) carefully and find out if the functionality is already covered, maybe by an individual configuration. |
There was a problem hiding this comment.
At some point in the near future I'd like to write a short doc specifically about how to enable different behavior for events via config or simple overrides -- at that point, this should link there instead.
Relatedly, we should alter the last point to specifically talk about juggling different events.
| @@ -1,46 +1,46 @@ | |||
| # Ubersystem Configuration | |||
There was a problem hiding this comment.
Is GitHub just being weird about file movements? Normally it doesn't generate full diffs for file moves.
I just used https://generator.contributing.md/ and then also renamed some files that made me twitch