|
1 | 1 |
|
2 | 2 | --- |
3 | 3 |
|
4 | | -# Developer Notes Repository |
| 4 | +# 🚀 DevNotes |
5 | 5 |
|
6 | | -Welcome to the Developer Notes repository! This repo serves as a collection of important tips, cheat sheets, best practices, and reference notes useful for our development and operations teams. Everyone is encouraged to contribute and help improve the collective knowledge base. |
| 6 | +### Your Personal Developer Knowledge Operating System |
| 7 | + |
| 8 | +> A curated, structured, and evolving collection of developer cheat sheets, system design notes, workflows, terminal tricks, and real-world engineering learnings. |
| 9 | +
|
| 10 | +[](#how-to-contribute) |
| 11 | +[](LICENSE) |
| 12 | +[](https://github.com/Nymphalys/DevNotes) |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## ✨ Why This Repository Exists |
| 17 | + |
| 18 | +Every developer Googles the same things again and again. |
| 19 | + |
| 20 | +This repository exists to: |
| 21 | + |
| 22 | +* 🧠 Eliminate repeated Googling |
| 23 | +* ⚡ Speed up debugging & development |
| 24 | +* 📚 Build a second brain for engineering |
| 25 | +* 🤝 Encourage team-wide knowledge sharing |
| 26 | +* 🔄 Keep practical notes version-controlled |
| 27 | + |
| 28 | +This is not documentation. |
| 29 | +This is a **developer survival kit**. |
7 | 30 |
|
8 | 31 | --- |
9 | 32 |
|
10 | | -## Table of Contents |
| 33 | +## 📂 What You'll Find Here |
11 | 34 |
|
12 | | -- [Purpose](#purpose) |
13 | | -- [Getting Started](#getting-started) |
14 | | -- [How to Contribute](#how-to-contribute) |
15 | | -- [Raising Issues](#raising-issues) |
16 | | -- [Submitting Pull Requests](#submitting-pull-requests) |
17 | | -- [Code of Conduct](#code-of-conduct) |
18 | | -- [Contact](#contact) |
| 35 | +* 🖥️ Terminal & CLI Cheatsheets |
| 36 | +* 🐳 Docker & DevOps Commands |
| 37 | +* 🛠️ Git Workflows & Fixes |
| 38 | +* 🌐 API & Backend Notes |
| 39 | +* ⚛️ Frontend Patterns |
| 40 | +* 🧪 Debugging Playbooks |
| 41 | +* 🔐 Security Quick References |
| 42 | +* 📊 Performance Optimization Tips |
| 43 | +* 🧩 Architecture & System Design Notes |
19 | 44 |
|
20 | 45 | --- |
21 | 46 |
|
22 | | -## Purpose |
| 47 | +## 🧠 Philosophy |
| 48 | + |
| 49 | +> "Document once. Reuse forever." |
23 | 50 |
|
24 | | -This repository aims to: |
| 51 | +* Keep it practical. |
| 52 | +* Keep it minimal. |
| 53 | +* Keep it searchable. |
| 54 | +* Keep it real-world tested. |
25 | 55 |
|
26 | | -- Centralize valuable information and cheat sheets on technologies, tools, and processes. |
27 | | -- Maintain up-to-date documentation for commonly used commands, scripts, and workflows. |
28 | | -- Encourage collaboration and knowledge sharing within the team and wider community. |
| 56 | +If it's not useful in real projects, it doesn't belong here. |
29 | 57 |
|
30 | 58 | --- |
31 | 59 |
|
32 | | -## Getting Started |
| 60 | +## 🚀 Getting Started |
33 | 61 |
|
34 | | -- **Clone the repository** |
| 62 | +### 1️⃣ Clone the Repository |
35 | 63 |
|
36 | | - ```bash |
37 | | - git clone https://github.com/Nymphalys/DevNotes.git |
38 | | - cd DevNotes |
39 | | - ``` |
| 64 | +```bash |
| 65 | +git clone https://github.com/Nymphalys/DevNotes.git |
| 66 | +cd DevNotes |
| 67 | +``` |
40 | 68 |
|
41 | | -- **Explore existing notes** |
| 69 | +### 2️⃣ Explore by Topic |
42 | 70 |
|
43 | | - - Browse markdown files (`.md`) organized by topic or technology. |
44 | | - - Search with your editor or GitHub’s search to find relevant info. |
| 71 | +Browse the markdown files organized by technology or concept. |
45 | 72 |
|
46 | | -- **Check contribution guidelines** |
| 73 | +Use GitHub search or: |
47 | 74 |
|
48 | | - - See below for how to suggest improvements or add new material. |
| 75 | +```bash |
| 76 | +⌘ + F |
| 77 | +``` |
| 78 | + |
| 79 | +to quickly find what you need. |
49 | 80 |
|
50 | 81 | --- |
51 | 82 |
|
52 | | -## How to Contribute |
| 83 | +## 🤝 How to Contribute |
| 84 | + |
| 85 | +We welcome contributions from: |
53 | 86 |
|
54 | | -We welcome contributions from everyone! Here's how you can help: |
| 87 | +* Engineers |
| 88 | +* DevOps folks |
| 89 | +* Interns |
| 90 | +* Students |
| 91 | +* Curious builders |
55 | 92 |
|
56 | | -- Add new cheat sheets, tips, or commands. |
57 | | -- Improve clarity, correctness, or formatting of existing notes. |
58 | | -- Suggest new topics that should be documented. |
59 | | -- Report errors or outdated information. |
| 93 | +### You can contribute by: |
| 94 | + |
| 95 | +* Adding new cheat sheets |
| 96 | +* Improving clarity of notes |
| 97 | +* Updating outdated commands |
| 98 | +* Adding real-world debugging solutions |
| 99 | +* Improving structure & categorization |
60 | 100 |
|
61 | 101 | --- |
62 | 102 |
|
63 | | -## Raising Issues |
| 103 | +## 🐞 Reporting Issues |
64 | 104 |
|
65 | | -If you find any problems or want to suggest improvements: |
| 105 | +If something is outdated or incorrect: |
66 | 106 |
|
67 | | -1. **Go to the Issues tab** on GitHub. |
68 | | -2. **Search existing issues** to avoid duplicates. |
69 | | -3. **Create a new issue** with: |
| 107 | +1. Go to **Issues** |
| 108 | +2. Search if it already exists |
| 109 | +3. Open a new issue with: |
70 | 110 |
|
71 | | - - A clear descriptive title. |
72 | | - - Detailed description including context, error messages, or suggestions. |
73 | | - - Examples or references if applicable. |
| 111 | + * Clear title |
| 112 | + * Context |
| 113 | + * Example if possible |
74 | 114 |
|
75 | | -4. **Label your issue (optional)** if you have permissions (e.g., bug, enhancement). |
| 115 | +We value clarity over volume. |
76 | 116 |
|
77 | 117 | --- |
78 | 118 |
|
79 | | -## Submitting Pull Requests (PRs) |
| 119 | +## 🔥 Submitting a Pull Request |
| 120 | + |
| 121 | +1. Fork this repository |
| 122 | +2. Create a branch |
80 | 123 |
|
81 | | -If you want to fix something or add new content: |
| 124 | +```bash |
| 125 | +git checkout -b feature/topic-name |
| 126 | +``` |
82 | 127 |
|
83 | | -1. **Fork the repository** to your GitHub account. |
84 | | -2. **Clone your fork** locally: |
| 128 | +3. Make your changes |
| 129 | +4. Commit clearly |
85 | 130 |
|
86 | | - ```bash |
87 | | - git clone https://github.com/Nymphalys/DevNotes.git |
88 | | - cd DevNotes |
89 | | - ``` |
| 131 | +```bash |
| 132 | +git commit -m "Add Redis troubleshooting guide" |
| 133 | +``` |
90 | 134 |
|
91 | | -3. **Create a new branch** for your change: |
| 135 | +5. Push and open a PR |
92 | 136 |
|
93 | | - ```bash |
94 | | - git checkout -b feature/your-topic |
95 | | - ``` |
| 137 | +--- |
96 | 138 |
|
97 | | -4. **Make your changes** (add notes, fix typos, improve formatting). |
98 | | -5. **Commit your changes** with meaningful message: |
| 139 | +## 🏗️ Contribution Guidelines |
99 | 140 |
|
100 | | - ```bash |
101 | | - git commit -am "Add jq cheat sheet with examples" |
102 | | - ``` |
| 141 | +* Keep markdown clean and structured |
| 142 | +* Use headings consistently |
| 143 | +* Add examples wherever possible |
| 144 | +* Avoid unnecessary long explanations |
| 145 | +* Focus on actionable information |
103 | 146 |
|
104 | | -6. **Push branch to your fork**: |
| 147 | +If possible, include: |
105 | 148 |
|
106 | | - ```bash |
107 | | - git push origin feature/your-topic |
108 | | - ``` |
| 149 | +* Command |
| 150 | +* What it does |
| 151 | +* When to use it |
| 152 | +* Example usage |
109 | 153 |
|
110 | | -7. **Open a Pull Request** from your fork/branch on GitHub. |
111 | | -8. Fill PR description with what you changed and why. |
112 | | -9. Respond politely to any feedback. |
| 154 | +--- |
113 | 155 |
|
| 156 | +## 📈 Roadmap |
| 157 | + |
| 158 | +* [ ] Add System Design section |
| 159 | +* [ ] Add Interview Preparation Notes |
| 160 | +* [ ] Add Production Incident Playbooks |
| 161 | +* [ ] Add Cloud (AWS/GCP/Azure) Cheatsheets |
| 162 | +* [ ] Add Architecture Diagrams |
| 163 | + |
| 164 | +--- |
| 165 | + |
| 166 | +## 🌍 Who Is This For? |
| 167 | + |
| 168 | +* Developers building real systems |
| 169 | +* Teams that want shared knowledge |
| 170 | +* Students preparing for tech interviews |
| 171 | +* Engineers who hate forgetting commands |
114 | 172 |
|
115 | 173 | --- |
116 | 174 |
|
117 | | -## Contact |
| 175 | +## ⭐ Support This Project |
118 | 176 |
|
119 | | -For questions or help, please contact: |
120 | | -- Project Maintainer: [nymphalys](https://github.com/nymphalys) |
| 177 | +If you find this useful: |
121 | 178 |
|
| 179 | +* Star ⭐ the repository |
| 180 | +* Share it |
| 181 | +* Contribute |
| 182 | +* Improve it |
122 | 183 |
|
123 | 184 | --- |
124 | 185 |
|
125 | | -*Thank you for helping make this knowledge base useful and comprehensive!* |
| 186 | +## 👩💻 Maintainer |
| 187 | + |
| 188 | +Maintained by: |
| 189 | +🔗 [nymphalys](https://github.com/nymphalys) |
| 190 | + |
| 191 | +--- |
| 192 | + |
| 193 | +## 📜 License |
| 194 | + |
| 195 | +MIT License – Feel free to use, modify, and improve. |
| 196 | + |
| 197 | +--- |
| 198 | + |
| 199 | +### 💡 Final Thought |
| 200 | + |
| 201 | +A strong engineer doesn’t just code. |
| 202 | +They document, refine, and optimize their thinking. |
| 203 | + |
| 204 | +This repository is a step toward that. |
126 | 205 |
|
127 | 206 | --- |
128 | 207 |
|
0 commit comments