GH-12: Add Code of Conduct, Contributing Guidelines, and Issue Forms

[dassenyy]

Changes

• Code of Conduct
  • Added the same Contributor Covenant v2.1 used in the repository of the website for the sake of consistency.
• Contributing Guidelines
  • Went over how one can contribute, how to set up the development environment, and everything important to know when submitting changes, especially pointing out the Conventional Commits specification.
  • Tried to keep it short and to the point.
• Issue Forms
  • Used issue forms instead of issue templates so users can create issues through a clean UI with textareas. I have added screenshots of the preview of the issue forms below, but note that the preview is somewhat weirdly formatted compared to actually opening an issue through the issue form (textarea size, spacing, order of elements, etc.).
  • Added a "Bug Report" and a "Feature Request" form.
  • Set up config to allow for a blank issue as an alternative.
• Other Changes
  • Removed .github/ from the .gitignore to add issue forms.

Attachments

gh-12

[okunamayanad]

Apart from COC, everything seems fine. I quite like the questions chosen for the issue templates but I'm not familiar with GitHub issue templates and couldn't figure out how to test them properly. If they're working, the questions look good to me

[okunamayanad]

I'm guessing this is a code of conduct template. If so, I don't think making people read a code of conduct makes sense when the code of conduct isn't made for the project. These seem like common sense and things that should be kept the same across all open source projects anyways and I'd say making people read this would either introduce unnecessary friction for contributing or they would notice this is a template and just skip reading it.

[dassenyy]

Thanks for sharing your thoughts on this. I do see the point about the Contributor Covenant template feeling too generic or impersonal. However I don't see the issue with it "not being made for the project", since a code of conduct is usually meant to consistently apply within all community spaces, rather than being specific to a project. I hope I don't misunderstand you here when you say "project", I assumed it meant this repository. And while I also agree that most of the content seems like common sense and that the template might feel like it is too formal or too explicit, I do think it is important to state expectations clearly.

I am definitely open to rewriting it from scratch instead of using a template if that is preferred. I can shorten it and simplify the language as needed. My main goal is to have a consistent code of conduct across the community, that was the reason for choosing it as mentioned in the pull request.

[dassenyy]

Could I get a quick update on this? I would be happy to draft a new version of the code of conduct from scratch, but if a server admin wants to take the lead on that, I could instead create a new issue to just add the contributing guidelines and the issue forms, and then close this PR along with the related issue #12.

[okunamayanad]

Could I get a quick update on this? I would be happy to draft a new version of the code of conduct from scratch, but if a server admin wants to take the lead on that, I could instead create a new issue to just add the contributing guidelines and the issue forms, and then close this PR along with the related issue #12.

Hi, sorry for the late reply, I was a bit overwhelmed with the work going on https://github.com/HytaleModding/site and things in my personal life.

My thoughts on the coc template is that it should only contain things that you wouldn't just default to expecting. For example, the commit message structure if the project has one. Although I get the point that cocs are generally not used like this.

I was proposing to not have a coc if we're just going to have generic things. I wasn't sure about how others were thinking of this so instead of marking as changes requested, just left it as a comment. @ItsNeil17 could we get your ideas on this one too?

[dassenyy]

Okay I see. I agree with keeping a single code of conduct across repositories. This is also something that can always be revisited later when things are less busy (like writing something short that's close to the rules on the Discord server and contains reporting guidelines), but I do think it's important to have one. I don't think there's anything else I can add here, if a decision is made, this conversation can be closed.

[okunamayanad]

@dassenyy The issue templates you've made looks awesome! Could we also have them on the https://github.com/HytaleModding/site repo? I could add them and add you as a co-author or you could make a PR if you'd like.

[dassenyy]

@okunamayanad Sure, you can add them to the site repository and list me as a co-author :)

[dassenyy]

I have marked this PR as a draft, since I wanted to adjust the section "Setting up a Development Environment" in the contributing guidelines to include some info about setting up a development database, as this replaced the database file.

[dassenyy]

@ItsNeil17 Alright this is done too now, updated README with new information about contributing standards and setting up a development environment, as well as info about configuring env variables like database connection options and the config file