11# Contributing to Tech Notes Hub
22
3- First off , thank you for taking the time to contribute! 🎉
4- Your help is what makes this project valuable for the whole developer community.
3+ First of all , thank you for taking the time to contribute! 🎉
4+ Your contributions help make this project more valuable for the developer community.
55
66## 🚀 Ways to Contribute
77
8- There are many ways you can contribute :
8+ There are many ways you can participate :
99
1010- 📚 Add new technical notes or topics
1111- 💡 Improve existing explanations or code snippets
12- - 🐛 Report issues or suggest improvements
13- - ✨ Refactor or clean up content formatting
12+ - 🐛 Report bugs or suggest improvements
13+ - ✨ Clean up and standardize content formatting
1414- 🌍 Translate notes to other languages (coming soon)
1515
1616## 📝 Contribution Guidelines
1717
18- Please follow these guidelines to keep things consistent and easy to manage :
18+ Please follow these guidelines to ensure consistency and maintainability :
1919
2020### 1. Fork the Repository
2121
22- Click the "Fork" button on the top right of this page. This will create a copy of the repository in your account.
22+ Click the "Fork" button in the top- right corner of the GitHub page to create a copy of the repository in your account.
2323
24- ### 2. Clone Your Fork
24+ ### 2. Clone to Your Machine
2525
2626``` bash
2727git clone https://github.com/your-username/tech-notes.git
@@ -30,19 +30,59 @@ cd tech-notes-hub
3030
3131### 3. Create a New Branch
3232
33- Use a clear, descriptive branch name for your changes :
33+ Name your branch clearly, briefly describing what you'll add or modify :
3434
3535``` bash
3636git checkout -b feature/add-graph-algorithms
3737```
3838
39- ### 4. Make Changes
39+ ### 🧩 Branch Naming Rules
4040
41- * Follow the structure of existing folders and files
42- * Use markdown (` .md ` ) for text-based notes
43- * Add code snippets inside fenced code blocks (e.g., \`\`\` python)
44- * Keep explanations clear and concise
45- * Add inline comments if needed
41+ Branch names should follow this structure:
42+
43+ ``` bash
44+ < change-type> /< brief-description>
45+ ```
46+
47+ | Type | Meaning | Example |
48+ | ---------- | ----------------------------------------------------- | -------------------------------- |
49+ | ` feature ` | Add new notes/sections | ` feature/add-docker-notes ` |
50+ | ` fix ` | Fix content errors, typos, examples | ` fix/typo-in-graph-note ` |
51+ | ` update ` | Update or improve existing notes | ` update/aws-ec2-note ` |
52+ | ` refactor ` | Restructure files/content without changing core ideas | ` refactor/reorganize-folders ` |
53+ | ` remove ` | Remove outdated or inappropriate content | ` remove/duplicate-array-example ` |
54+ | ` docs ` | Update project documentation like README, CONTRIBUTING| ` docs/improve-readme ` |
55+
56+ ### 4. Make Your Changes
57+
58+ * Follow the existing folder and file structure
59+ * Notes should use Markdown format (` .md ` )
60+ * Code should be placed in fenced code blocks, e.g., \`\`\` python
61+ * Keep explanations concise and clear
62+ * Add inline comments if necessary
63+
64+ ### 💬 Commit Message Rules
65+
66+ Write clear, meaningful, and understandable commit messages. Suggested structure:
67+
68+ ``` bash
69+ < change-type> : < brief description>
70+ ```
71+
72+ #### 📌 Examples:
73+
74+ - ` feature: add notes on HTTP Status Codes `
75+ - ` fix: correct typos in design-patterns.md `
76+ - ` update: improve binary search examples `
77+ - ` remove: delete duplicate notes in aws folder `
78+ - ` docs: add instructions for creating pull requests `
79+
80+ #### 🧠 Additional Tips:
81+
82+ - You can write in ** English or Vietnamese** (be consistent within one pull request)
83+ - ** Avoid vague commits** like: ` update 1 ` , ` fix bug ` , ` test `
84+ - If related to an issue, add the number at the end:
85+ 👉 ` fix: typo in aws-note #12 `
4686
4787### 5. Commit & Push
4888
@@ -52,34 +92,35 @@ git commit -m "Add notes on graph algorithms"
5292git push origin feature/add-graph-algorithms
5393```
5494
55- ### 6. Open a Pull Request
95+ ### 6. Create a Pull Request
5696
57- Go to the original repository and click ** "Compare & Pull Request"** . Provide :
97+ Go back to the original repository and click ** "Compare & Pull Request"** . Remember to include :
5898
59- * A clear title and description of your contribution
60- * Reference to any related issues (if any)
99+ * A clear, concise title
100+ * A detailed description of what you've added/modified
101+ * References to related issues if applicable
61102
62- ## ✅ PR Review Checklist
103+ ## ✅ Checklist Before Submitting a Pull Request
63104
64- Before submitting your pull request, make sure :
105+ Before submitting, ensure :
65106
66- * [ ] Your content is well- formatted and follows the repo structure
67- * [ ] You've checked for typos or broken links
68- * [ ] Code snippets (if any) are working and correct
69- * [ ] No sensitive or proprietary information is included
107+ * [ ] Content is properly formatted and follows project structure
108+ * [ ] No spelling errors or broken links
109+ * [ ] Code snippets (if any) work correctly
110+ * [ ] No sensitive information or proprietary assets included
70111
71- ## 📁 Naming & File Guidelines
112+ ## 📁 File & Folder Naming Conventions
72113
73- * Use lowercase and hyphens for file/ folder names: ` graph-traversal.md `
74- * For non-English versions, use a suffix: ` graph-traversal_vi.md `
75- * Group related notes into folders (e.g., ` algorithms/ ` , ` aws/ ` , ` design-patterns/ ` )
114+ * Use lowercase and hyphens for file and folder names: ` graph-traversal.md `
115+ * For translations, add language suffix: ` graph-traversal_vi.md `
116+ * Notes should be grouped by topic folders (e.g., ` algorithms/ ` , ` aws/ ` , ` design-patterns/ ` )
76117
77118## 🤝 Code of Conduct
78119
79- Be respectful, open-minded , and constructive in your interactions. We’ re building a friendly and inclusive learning space for all developers.
120+ Be respectful, open, and constructive in all interactions. We' re building a friendly and inclusive learning space for all developers.
80121
81122## 📩 Need Help?
82123
83- Feel free to [ open an issue] ( https://github.com/tech-notes-hub/tech-notes/issues ) if you have questions, ideas, or feedback .
124+ If you have questions or ideas, please [ create a new issue] ( https://github.com/tech-notes-hub/tech-notes/issues ) .
84125
85- Thanks for contributing to ** Tech Notes Hub** ! 🙌
126+ Thank you again for contributing to ** Tech Notes Hub** ! 🙌
0 commit comments