You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(dev): implement development automation and update docs
Add comprehensive Makefile for development automation and refactor
contributing guide for clarity and completeness.
- Add Makefile with features:
* Development commands (fmt, clippy, test, audit)
* Release management with semantic versioning
* Changelog automation with git-cliff
* Colored output and helpful messages
* Development vs release checks separation
* Package verification and publishing support
- Update CONTRIBUTING.md:
* Add detailed guide for development workflow
* Improve release process documentation
* Add troubleshooting section
* Include yanking instructions
* Add best practices
* Update commands to use Make
The new automation system simplifies development setup, standardizes
quality checks, and provides a clear process for contributors.
Thank you for considering contributing to this project! This guide will help you understand our workflow, coding standards, and release process. Whether you're fixing a bug, adding a feature, or improving documentation, your contribution is highly appreciated!
3
+
Thank you for considering contributing to this project! This guide will help you understand our workflow, coding standards, and release process.
4
+
5
+
## Ways to Contribute
6
+
7
+
1.**Opening Issues**
8
+
- Report bugs with detailed descriptions
9
+
- Suggest enhancements
10
+
- Request features
11
+
- Create detailed issue descriptions using templates
12
+
- Use issue templates for bugs and features
13
+
14
+
2.**Adding Context**
15
+
- Provide reproduction steps
16
+
- Share code snippets
17
+
- Add screenshots
18
+
- Write use cases
19
+
- Add examples and scenarios
20
+
- Link to related issues or PRs
21
+
22
+
3.**Resolving Issues**
23
+
- Fix bugs
24
+
- Implement features
25
+
- Improve documentation
26
+
- Enhance performance
27
+
- Demonstrate that an issue is not a problem
28
+
- Open pull requests with fixes
29
+
30
+
4.**Reviewing Pull Requests**
31
+
- Review code changes
32
+
- Test proposed features
33
+
- Suggest improvements
34
+
- Share domain expertise
35
+
- Help maintain code quality
36
+
- Participate in technical discussions
37
+
38
+
## Development Setup
39
+
40
+
We use Make to automate development tasks. Start by setting up your environment:
4
41
5
-
## Ways to contribute
6
-
7
-
There are fundamentally four ways an individual can contribute:
42
+
```bash
43
+
make setup
44
+
```
8
45
9
-
1.**By opening an issue:** For example, if you believe that you have uncovered a bug,
10
-
creating a new issue in the issue tracker is the way to report it.
11
-
2.**By adding context:** Providing additional context to existing issues,
12
-
such as screenshots and code snippets.
13
-
3.**By resolving issues:** Either demonstrating that the issue is not a problem,
14
-
or opening a pull request with a fix.
15
-
4.**By reviewing pull requests:** Help review and discuss proposed changes.
46
+
This installs required tools:
16
47
17
-
**Anybody can participate in any stage of contribution**. We urge you to participate in the discussion around bugs and participate in reviewing PRs.
0 commit comments