Skip to content

Commit 3614550

Browse files
committed
docs: Improve and extend the docs
1 parent 9f4c225 commit 3614550

11 files changed

+1393
-292
lines changed

CONTRIBUTING.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Contributing to Decent Cloud
2+
3+
First off, thank you for considering contributing to Decent Cloud! It's people like you that make Decent Cloud such a great tool.
4+
5+
## Quick Links
6+
7+
- 📚 [Development Guide](docs/development.md) - Comprehensive development setup and guidelines
8+
- 💬 [Discussions](https://github.com/orgs/decent-stuff/discussions) - Community discussions
9+
- 🐛 [Issue Tracker](https://github.com/decent-stuff/decent-cloud/issues) - Report bugs or request features
10+
- 📖 [Documentation](docs/) - Project documentation
11+
12+
## Ways to Contribute
13+
14+
1. **Code Contributions**
15+
16+
- Bug fixes
17+
- New features
18+
- Performance improvements
19+
- Documentation updates
20+
21+
2. **Documentation**
22+
23+
- Improve existing docs
24+
- Fix typos or clarify language
25+
- Add examples or tutorials
26+
- Translate documentation
27+
28+
3. **Bug Reports**
29+
30+
- Submit detailed bug reports
31+
- Provide reproduction steps
32+
- Share error logs
33+
- Suggest fixes if possible
34+
35+
4. **Feature Requests**
36+
- Suggest new features
37+
- Provide use cases
38+
- Discuss implementation ideas
39+
40+
## Development Setup
41+
42+
See our [Development Guide](docs/development.md) for detailed instructions on:
43+
44+
- Setting up your development environment
45+
- Building the project
46+
- Running tests
47+
- Code style guidelines
48+
49+
## Pull Request Process
50+
51+
1. **Fork & Create Branch**
52+
53+
- Fork the repository
54+
- Create a feature branch
55+
- Make your changes
56+
- Keep commits focused and logical
57+
58+
2. **Code Quality**
59+
60+
- Follow Rust style guidelines
61+
- Add/update tests
62+
- Update documentation
63+
- Run the test suite
64+
65+
3. **Submit PR**
66+
67+
- Create a pull request
68+
- Describe your changes
69+
- Link related issues
70+
- Update changelog
71+
72+
4. **Review Process**
73+
- Address review feedback
74+
- Make requested changes
75+
- Maintain professional discourse
76+
- Be patient and responsive
77+
78+
## Commit Messages
79+
80+
Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
81+
82+
```
83+
type(scope): description
84+
85+
[optional body]
86+
87+
[optional footer]
88+
```
89+
90+
Types:
91+
92+
- feat: New feature
93+
- fix: Bug fix
94+
- docs: Documentation
95+
- style: Formatting
96+
- refactor: Code restructuring
97+
- test: Adding tests
98+
- chore: Maintenance
99+
100+
## Code of Conduct
101+
102+
### Our Standards
103+
104+
- Be respectful and inclusive
105+
- Accept constructive criticism
106+
- Focus on what's best for the community
107+
- Show empathy towards others
108+
109+
### Our Responsibilities
110+
111+
- Maintain project quality
112+
- Review contributions fairly
113+
- Address issues promptly
114+
- Foster a welcoming environment
115+
116+
## Getting Help
117+
118+
- 📝 [Open an Issue](https://github.com/decent-stuff/decent-cloud/issues)
119+
- 💬 [Join Discussions](https://github.com/orgs/decent-stuff/discussions)
120+
- 📚 [Read Documentation](docs/)
121+
122+
## Recognition
123+
124+
Contributors will be:
125+
126+
- Listed in CONTRIBUTORS.md
127+
- Mentioned in release notes
128+
- Recognized in project documentation
129+
130+
Thank you for contributing to Decent Cloud!

Cargo.lock

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ members = [
1010
]
1111

1212
[workspace.package]
13-
version = "0.1.10"
13+
version = "0.2.0"
1414
edition = "2021"
1515

1616
[workspace.dependencies]

0 commit comments

Comments
 (0)