Open Source Related Files

[frasermcc9]

Is your feature request related to a problem? Please describe.
Its important to give contributors context and information about how to contribute to the project. This thread will discuss root-level files that we would want in our project.

Describe the solution you'd like
I propose the following configs and documents:

License

I'm defaulting to MIT but if anyone has a preference (i.e. gpl family) then please discuss.

Contributing.md

A summary guide on how the project should be contributed to, such as git conventions, code review conventions etc.

Readme.md

A file introducing the project, and usage for end users.

.gitignore and .gitattributes

Repo related files to be ignored and gitattributes to enforce things like line endings and treating files as binary. Going to suggest that if you haven't already, I suggest placing your IDE and OS files in a global gitignore since these aren't really relevant to the repo.

CODE_OF_CONDUCT.md

Outlines the rules for contributing. I suggest we just use one like this

CODEOWNERS

Gives us the ability to assign ownership over certain parts of the code. This means contributors know who to ask for reviews when modifying files or directories (and can even be set as a branch protection requirement). Keen to hear others thoughts on this.

.editorconfig

Apply some global styling rules (although may be unneeded if we are going with the monorepo structure).

Anything else?

If anything here seems unneeded, adjusting, or anything is missing, please discuss below.

Implemented in #5

[oscarli00]

Just want to bring up a point about the CODEOWNERS file. The assignment says everyone should do at least one code review so if we go with this route, we should make sure everyone should have the opportunity to be a reviewer.

[frasermcc9]

Just want to bring up a point about the CODEOWNERS file. The assignment says everyone should do at least one code review so if we go with this route, we should make sure everyone should have the opportunity to be a reviewer.

Good point, the nature of CODEOWNERS should make this possible since the default owner of any code is everyone in the group. We can define more specific ownership for certain files if needed, i.e. we might have a couple people who become very familiar with something like a db schema file, so it makes sense any changes to that would be reviewed by someone in that group.

[fishmonger45]

add in a prettier config later when we have the yarn workspace set up