Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2025, Gabzetdinov Ruslan
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the project nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# ⚙️ Develop Rules & Engineering Standards

This repository provides unified development rules, workflows, and templates across several engineering domains — including Git, C/C++ (desktop & embedded), Python, and beyond.
It aims to ensure consistency and clarity across teams and platforms.

---

## 📦 Quick Start

To create templates & wiki for your repo:

### ✅ Use a prebuilt archive

Download the latest `.run` file from the [Releases](https://github.com/<your-org>/<your-repo>/releases) page and execute it on any POSIX-compatible system:

```bash
chmod +x develop-rules-v*.run
./develop-rules-v*.run
```

### 🔧 Or build your own

If you want to build a customized version from source, follow the instructions in [`release/README.md`](release/README.md)

---

## 🗺️ Roadmap (2025)

| Area | Description | Progress |
| - | - | - |
| ✅ Git & Workflow (Base) | Branching, issues, naming, commit/PR policy | **100%** |
| 🟡 C/C++ Desktop | Project layout, build system, logging, testing | **20%** |
| ⚪ C/C++ Embedded | Bare-metal, RTOS, linker scripts, debugging | **0%** |
| ⚪ Python CLI | Command-line tools, packaging, venv, typing, testing | **0%** |
| ⚪ PySide | Desktop GUI structure, integration with C++ core | **0%** |
| ⚪ Flutter / Dart | Cross-platform GUI architecture, embedded integration | **0%** |
| ⚪ Go CLI | CLI structure, install/update flow, modular packaging | **0%** |
| ⚪ Bash / POSIX | Scripting practices, modularity, cross-distro support | **0%** |

> Progress is approximate and updated manually

---

## 🤝 Contributing

Contributions are welcome!
Please follow Git-related naming and branching rules described in [`git/`](./git), and submit well-scoped pull requests

---

## 📄 License

This project is licensed under the BSD 3-Clause License
You are free to use, modify, and redistribute the code and materials, provided that:.

- The original copyright and license are retained
- Binary redistributions include the same disclaimer
- The project name and author(s) are not used to promote derivative works without permission

See [LICENSE](./LICENSE) for full terms