Feature: Move `CONTRIBUTING.md` and `i18n-guidelines.md` to the root

[adiati98]

Suggested solution

Background

As I'm trying to find a way to create a base for our community translations, it gave me a thought.

So far, I don't see any open source project that has contributing & translation guidelines chapters on their live website. Usually, they have either:

• "Edit this page on GH" that bring folks to the page file on GH, or

• Link to the repo on GH.

  But we do have contributing guidelines and translations guidelines live on our website. I think it makes more sense if these files live only in the repo.

For that reason, I propose to move CONTRIBUTING.md and i18n-guidelines.md to the root. We will still link these on the homepage of the course.

Alternative

If we want to be a bit more organized, we can follow GH docs repo. They have a contributing folder that contains various contributing guidelines. So we can create a contributing folder at the root and move the guidelines files into this folder.

Community Translations

In the forked repo of translations, they will have these in their root:

• Translated CONTRIBUTING.md.
• Translated i18n-guidelines.md.

• A contributing file that contains guidelines to contribute to the forked repo.

  They can name it anything, but preferably consistent across forked repos for documentation matter. So, maybe something like: CONTRIBUTING-TO-LANG.md and change the LANG to the translated languange. For example: CONTRIBUTING-TO-ES.md. They can link this file in the README on the root. This file can be upper- or lower-case. It doesn't matter as there is no convention for this. However, we want this to be consistent across forked repos.

[adiati98]

@BekahHW I need your thoughts and want to discuss this further with you whenever you have time. Thanks! 🙂

[adiati98]

@BekahHW I'm considering to remove the "Contributing to This Repository" and "License" sections from both courses' README (as screenshot below) and leave those only in the homepage.

I looked at open source projects, some of them don't mention about contrib guidelines on their websites (e.g., Astro, React), and some have a dedicated page for contrib guidelines (e.g., NextJS — navigate from the sidebar under "Community", GH Docs — listed on the homepage under "Community").

Any thoughts?

[BekahHW]

@BekahHW I'm considering to remove the "Contributing to This Repository" and "License" sections from both courses' README (as screenshot below) and leave those only in the homepage.

I looked at open source projects, some of them don't mention about contrib guidelines on their websites (e.g., Astro, React), and some have a dedicated page for contrib guidelines (e.g., NextJS — navigate from the sidebar under "Community", GH Docs — listed on the homepage under "Community").

Any thoughts?

License can definitely go in one place. If the contrib guidelines are the same for both, it makes sense to keep them in one place as well.