-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CONTRIBUTING.md and guidelines (#91)
* Add CONTRIBUTING.md * Update README.md with CONTRIBUTING.md * Minor improvemnts to contrinbuting.md
- Loading branch information
Showing
2 changed files
with
43 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <CTF> <YEAR>` | ||
|
||
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-<category>.md` (the category is optional) | ||
|
||
Other: | ||
- check emojis on https://gohugo.io/quick-reference/emojis/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters