Skip to content

docs: add resource type tagging guidance #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fengfeng-zi wants to merge 2 commits into from
+703 −685
Closed

docs: add resource type tagging guidance #847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7d8394
docs: add resource tag legend and examples
fengfeng-zi Apr 26, 2026
9081dc7
docs: require resource tags for new tutorial entries
fengfeng-zi Apr 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 23 additions & 16 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
# Contribution guidelines

Before making a pull request, please make sure of the following:
* The tutorial(s) you want to add do not already exist
* Your tutorial is correctly placed under the appropriate language/technology
* Improvements of the same tutorial are encouraged!
* The pull request needs to have a descriptive title
* If the language/technology of your tutorial does not exist, feel free to create a new entry in table of contents
* Make a separate pull request for each of the tutorial
* Use the following format `[Title](link_to_tutorial)`
# Contribution guidelines

Before making a pull request, please make sure of the following:
* The tutorial(s) you want to add do not already exist
* Your tutorial is correctly placed under the appropriate language/technology
* Improvements of the same tutorial are encouraged!
* The pull request needs to have a descriptive title
* If the language/technology of your tutorial does not exist, feel free to create a new entry in table of contents
* Make a separate pull request for each of the tutorial
* Use the following format `[Title](link_to_tutorial) [guide]`
* Append exactly one resource tag at the end of each new tutorial entry: `[guide] [video] [course] [book] [repo]`
* If your tutorial is a multi-part series, use the following format:
```
* Title
* [Part 1](link_to_part_1)
* [Part 2](link_to_part_2)
```
* Check the spelling and grammar
* Do the work, write good commit messages, and read the CONTRIBUTING file if there is one
* Remove any trailing whitespaces
* Links must be pointing straight to the tutorials, no URL shorteners. However, if the URL is too long (more than 80 characters), Google URL Shortener is allowed

Thank you for your suggestions! If you think there is anything to improve with the guidelines, please contact me at <tuvtran97@gmail.com>
* Valid single-entry examples:
```
* [Build a REST API](https://example.com) [guide]
* [Build a Game Engine](https://example.com) [video]
* [Create a Compiler](https://example.com) [repo]
```
* Check the spelling and grammar
* Do the work, write good commit messages, and read the CONTRIBUTING file if there is one
* Remove any trailing whitespaces
* Links must be pointing straight to the tutorials, no URL shorteners. However, if the URL is too long (more than 80 characters), Google URL Shortener is allowed

Thank you for your suggestions! If you think there is anything to improve with the guidelines, please contact me at <tuvtran97@gmail.com>
Loading