search

niu-gdo / IGDO-Fall-2023-Project

IGDO's Fall 2023 game project.
7 stars 0 forks source link

Add CONTRIBUTING document #27

Closed zgjs closed 10 months ago

zgjs commented 11 months ago

Hey team, this MR adds the CONTRIBUTING document for the repo. We used contributing.md to help create the template and added information specific to our project.

:speech_balloon: Please consider this a draft and suggest any additional changes that you think would be helpful before we merge it into main.

Part of #25

magictrick-dev commented 11 months ago

We should probably add a link to this into the README. Otherwise LGTM.

zgjs commented 11 months ago

We should probably add a link to this into the README. Otherwise LGTM. - @magictrick-dev

Good catch. We were thinking that it since it is a special file, it would be pinned to the repo info skinny or somewhere prominent, and we could also link to it in the PR template, but we should also link to it in the README.

(And we should also add the PR template for the second task in #25. I'm going to convert this MR to draft until we have those two changes and then I'll ask for re-review when it's undrafted.)

Jacobcon3315 commented 10 months ago

Reading through the document, it looks good! I have no comments on anything that should be added or removed.

Migs commented 10 months ago

The documment looks good. Should we add a coding guidelines section (i.e. format, comments, casing, etc), or have that be a separate file?

zgjs commented 10 months ago

The documment looks good. Should we add a coding guidelines section (i.e. format, comments, casing, etc), or have that be a separate file?

I think @ExplosiveEggshells was working on coding guidelines in a separate document, but we could update this one with a link to it.