Skip to content

Commit 36c3f52

Browse files
authored
Add community governance and improve documentation (#197)
* Add community governance and improve documentation - Add CODE_OF_CONDUCT.md with community behavior guidelines - Add CONTRIBUTING.md with contribution guidelines and development workflow - Add LICENSE with project license information - Improve README workflow monitoring section with detailed bullet points * Standardize headings and bullet points in README Updated formatting and capitalization for consistency.
1 parent 897609b commit 36c3f52

File tree

4 files changed

+388
-3
lines changed

4 files changed

+388
-3
lines changed

CODE_OF_CONDUCT.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Code of Conduct
2+
3+
We strive to create a welcoming and inclusive environment for everyone. To ensure this, please follow these guidelines:
4+
5+
- **Be Respectful and Considerate**: Remember that our community is global, and language and cultural differences may exist. Avoid using offensive or inappropriate language. Understand that what may be acceptable in one culture could be considered offensive in another.
6+
7+
- **Seek Clarification When Needed**: If you don't understand something, don't hesitate to ask questions. Similarly, if someone asks a question, be patient and provide a clear and helpful response. Avoid being offended by questions or requests for clarification.
8+
9+
- **Communication Challenges**: Recognize that not everyone finds communication easy. If you have difficulty expressing yourself, that's okay. We ask everyone to be patient and understanding, and to focus on the message rather than the way it is conveyed.
10+
11+
- **Be Patient and Understanding**: Recognize that contributors come from various backgrounds and levels of experience. If someone makes a mistake, offer constructive feedback rather than criticism.
12+
13+
- **Encourage Inclusivity**: Make an effort to include everyone in discussions, especially those who might be new or less experienced. Avoid jargon or acronyms without explanations, as these can be confusing for newcomers.
14+
15+
By following these guidelines, we can ensure a positive and productive environment for all contributors. If you encounter any issues or have concerns, please reach out to the project maintainers on GitHub, the Armbian forums, or Discord.

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to Armbian Infrastructure
2+
3+
We welcome contributions!
4+
5+
- **Bug reports**[Open an issue](https://github.com/armbian/armbian.github.io/issues)
6+
- **Feature requests** — Let's discuss it
7+
- **Pull requests** — Code improvements are always welcome
8+
- **Documentation** — Help others get started
9+
- **Infrastructure improvements** — CI/CD workflows, automation scripts, and data pipelines
10+
11+
### Development Workflow
12+
13+
1. Fork the repository
14+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
15+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
16+
4. Push to the branch (`git push origin feature/amazing-feature`)
17+
5. Open a Pull Request
18+
19+
20+
## Other ways to contribute
21+
22+
* [Become a new board maintainer](https://docs.armbian.com/Board_Maintainers_Procedures_and_Guidelines/)
23+
* [Apply for one of the positions](https://forum.armbian.com/staffapplications/)
24+
* [Help us covering costs](https://forum.armbian.com/subscriptions/)
25+
* [Help community members in the Forum](https://forum.armbian.com/)
26+
* [Check forum announcements section for any requests for help from the community](https://forum.armbian.com/forum/37-announcements/)

0 commit comments

Comments
 (0)