From e1d47e328e5574d75cc99684a4b3531e50bb1b48 Mon Sep 17 00:00:00 2001 From: ClementMabileau Date: Tue, 15 Oct 2024 16:38:47 +0200 Subject: [PATCH] Add CONTRIBUTING.md and guidelines (#91) * Add CONTRIBUTING.md * Update README.md with CONTRIBUTING.md * Minor improvemnts to contrinbuting.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ README.md | 11 ++++++++--- 2 files changed, 43 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4c99b58 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing + +## Contribute +To contribute to the website with **new features, improvements or UX/UI changes** feel free to open an [Issue](https://github.com/iScsc/blog.iscsc.fr/issues/new). +You can **fix bugs or typos** by submiting a [Pull Request](https://github.com/iScsc/blog.iscsc.fr/pulls). + +To **add or update content** gathered on this website give a look at our [tutorial](https://iscsc.fr/posts/publish-your-own-post/) for new contributors 🙂 +...or directly open a [Pull Request](https://github.com/iScsc/blog.iscsc.fr/pulls) if you already know how these things work 😉 + +Content is placed under [`./src/content`](https://github.com/iScsc/blog.iscsc.fr/tree/main/src/content). + +## Guidelines +When contributing to the website's content, please try to follow the following guidelines. + +Tags: +- **Use already existing tags** (mind tags proliferation) +- Use **singular** instead of plural --> TO FIX +- Most of the time use **2 to 5 tags** +- **No upper case** except for acronyms and FR +- [Non-English]\: Add an upper case tag for the language, for example `FR` for French + +Title: +- Title should be **straight to the point and explicit** +- [Non-English]\: Add an [emoji](https://gohugo.io/quick-reference/emojis/#country-flag) flag for the language at the end +- [Write-Ups]\: End title with `Write-Up ` + +Files: +- Use **lower-case, dash-separated names** +- Filenames will become URLs, they should be **explicit, relatively short and close to article's title** +- In case you have images: create a folder, place your article inside and name it `index.md`, an [example](https://github.com/iScsc/blog.iscsc.fr/tree/main/src/content/posts/publish-your-own-post) + *NOTE: called [leaf bundle](https://gohugo.io/content-management/page-bundles/#leaf-bundles) by HUGO* +- [Write-Ups]\: Name the file `name-of-challenge-wu-.md` (the category is optional) + +Other: +- check emojis on https://gohugo.io/quick-reference/emojis/ diff --git a/README.md b/README.md index 084ba47..bdd3ed5 100644 --- a/README.md +++ b/README.md @@ -162,7 +162,12 @@ Incoming features: ## Contributing -To contribute to the website **code or good-looking** feel free to open an [Issue](https://github.com/iScsc/blog.iscsc.fr/issues/new) for new features, improvements or UX/UI changes, or directly a [Pull Request](https://github.com/iScsc/blog.iscsc.fr/pulls) for bug fixes or typos. +*See [CONTRIBUTING.md](./CONTRIBUTING.md) for a complete guide to contributing and guidelines.* -To contribute to the **knowledge** gathered on this website give a look at our [tutorial](https://iscsc.fr/posts/publish-your-own-post/) for new contributors 🙂 -...or directly open a [Pull Request](https://github.com/iScsc/blog.iscsc.fr/pulls) if you already know how these things work 😉 \ No newline at end of file +To contribute to the website with **new features, improvements or UX/UI changes** feel free to open an [Issue](https://github.com/iScsc/blog.iscsc.fr/issues/new). +You can **fix bugs or typos** by submiting a [Pull Request](https://github.com/iScsc/blog.iscsc.fr/pulls). + +To **add or update content** gathered on this website give a look at our [tutorial](https://iscsc.fr/posts/publish-your-own-post/) for new contributors 🙂 +...or directly open a [Pull Request](https://github.com/iScsc/blog.iscsc.fr/pulls) if you already know how these things work 😉 + +Content is placed under [`./src/content`](https://github.com/iScsc/blog.iscsc.fr/tree/main/src/content). \ No newline at end of file