diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7273d36 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# NotEssential Contributions Guidelines + +Thank you for contributing to our website! It really helps in maintaining our website and keeping it up-to-date. +We recommend [joining our Discord server](https://discord.gg/wncdz7e8jy) so you can interact with NotEssential maintainers and ask for help in the NE chats. + +## Easily solvable using issues + +To request the inclusion of a mod, report a bug or request a change in documentation, please open an issue on the Issues tab, using the appropriate template. + +## Translate NotEssential + +To help translate NotEssential, please visit [our Crowdin page](https://crowdin.com/project/notessential) +If your language is not listed, join our Discord server and request your language to be added in the #ne-general chat. + +General guidelines for translations: + +- Unless they have an official name in your language, do NOT translate a mod's name into that language. +- Similarly, do NOT translate 'Essential'(the mod), 'Spark Universe', 'Mojang', or 'Microsoft' if there isn't an official name in that language. +- If there is an issue, please make a comment on the side panel and tick the `Issues` box. Then, select the related flag. +- When an area is in ALL CAPS, also write in ALL CAPS if you can with your language. + +If you have any more questions, please join our Discord and ask there. + +## Help code NotEssential + +To assist in developing NotEssential, fork this repository and create a new branch to start off with. +Then, checkout your branch locally and start coding. + +General guidelines for developing: + +- Make sure you look at the Pull Requests page to see if your idea has already been listed. If so, we recommend opening pull requests to the head branch/repository (the head branch is the branch merging to the repository). +- Make your commit names helpful so we can understand what you have changed. +- Install Prettier. You can run `pnpm add prettier` or install Prettier as a VS Code extension (this should have been recommended to you automatically!). If you use the extension, ensure `Format on Save` is set in VS Code settings. +- Make sure you use one of our pull request templates when making a pull request. + +If you need help or have identified an issue that you cannot solve by yourself, open an issue in the Issues tab. + +## Adding a mod to the alternatives page + +Similar to above, fork this repository and create a new branch based off `main`. +Then, checkout your branch locally and start coding. + +General guidelines when adding a mod are available in the pull request template provided. +Please also follow the guidelines in [Help code NotEssential](#help-code-notessential) when making your changes. + +For more help, please join our Discord server. diff --git a/components/contributingSection.vue b/components/contributingSection.vue new file mode 100644 index 0000000..db72cad --- /dev/null +++ b/components/contributingSection.vue @@ -0,0 +1,22 @@ + + + diff --git a/components/internalLink.vue b/components/internalLink.vue new file mode 100644 index 0000000..a388f04 --- /dev/null +++ b/components/internalLink.vue @@ -0,0 +1,14 @@ + + + diff --git a/components/reactiveHero.vue b/components/reactiveHero.vue new file mode 100644 index 0000000..cffc6c4 --- /dev/null +++ b/components/reactiveHero.vue @@ -0,0 +1,17 @@ + + + diff --git a/i18n/lang/en-US.json b/i18n/lang/en-US.json index 05b5b22..d1236a7 100644 --- a/i18n/lang/en-US.json +++ b/i18n/lang/en-US.json @@ -10,7 +10,8 @@ "about": "About", "credit_creator": "Originally created by", "credit_designed": "Designed by", - "interact": "Interact" + "interact": "Interact", + "contributing": "Contributing" } }, "landing": { @@ -20,6 +21,43 @@ "alternatives": "ALTERNATIVES" } }, + "contributing": { + "hero": "CONTRIBUTING", + "subhero": "To the NotEssential website", + "welcome": "Want to contribute to NotEssential? Here are some guidelines.", + "end": "If you have any more questions, please join our Discord and ask there.", + "titles": { + "translating": "Translating", + "coding": "Developing", + "alternatives": "Submitting Alternatives" + }, + "subtitles": { + "translating": "To help translate NotEssential, please visit our Crowdin page. If your language is not listed, join our Discord server and request your language to be added in the #ne-general chat.", + "coding": "To assist in developing NotEssential, fork this repository and create a new branch to start off with. Then, checkout your branch locally and start coding.", + "alternatives": "Similar to above, fork this repository and create a new branch based off `main`. Then, checkout your branch locally and start coding." + }, + "guidelines": { + "translating": [ + "Unless they have an official name in your language, do NOT translate a mod's name into that language.", + "Similarly, do NOT translate 'Essential' (the mod), 'Spark Universe', 'Mojang', or 'Microsoft' if there isn't an official name in that language.", + "If there is an issue, please make a comment on the side panel and tick the 'Issues' box. Then, select the related flag.", + "When an area is in ALL CAPS, also write in ALL CAPS if you can with your language." + ], + "coding": [ + "Make sure you look at the Pull Requests page to see if your idea has already been listed. If so, we recommend opening pull requests to the head branch/repository (the head branch is the branch merging to the repository).", + "Make your commit names helpful so we can understand what you have changed.", + "Install Prettier. You can run 'pnpm add prettier' or install Prettier as a VS Code extension (this should have been recommended to you automatically!). If you use the extension, ensure 'Format on Save' is set in VS Code settings.", + "Make sure you use one of our pull request templates when making a pull request." + ], + "alternatives": [ + "Make sure your project replaces a feature of Essential.", + "Please detail why your project should be added to the page.", + "Also submit a short description of your project, though this is optional.", + "This should be obvious, but please don't submit a Trojan or other form of malware.", + "Please don't just use this site as 'free advertising' for your project." + ] + } + }, "alternatives": { "hero": "ALTERNATIVES", "reason": "Essential has many issues. This page provides alternatives.", diff --git a/layouts/default.vue b/layouts/default.vue index 6f32668..7a3b839 100644 --- a/layouts/default.vue +++ b/layouts/default.vue @@ -70,6 +70,11 @@ {{ $t("layout.footer.interact") }} + {{ + $t("layout.footer.contributing") + }} + Crowdin diff --git a/pages/alternatives.vue b/pages/alternatives.vue index 6fd5e4d..c83be11 100644 --- a/pages/alternatives.vue +++ b/pages/alternatives.vue @@ -1,7 +1,7 @@