Added Contribution markdown file and a section in the readme.

This commit is contained in:
Axel Wretman
2025-09-09 15:06:23 +02:00
parent 70acc528ac
commit 360cdc46f2
2 changed files with 53 additions and 2 deletions

36
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,36 @@
# Contributing to OpenNoodl
Thank you for your interest in contributing! Heres how you can help:
## How to Contribute
1. **Fork the repository** and create your feature branch:
```bash
git checkout -b feature/my-feature
```
2. **Make your changes** and ensure your code follows the existing style and conventions.
3. **Test your changes** locally.
4. **Commit your changes** with a clear message:
```bash
git commit -am 'Add new feature'
```
5. **Push to your branch**:
```bash
git push origin feature/my-feature
```
6. **Open a pull request** on GitHub. Describe your changes and the motivation behind them.
## Guidelines
- The branch name should be descriptive of the feature or fix. Either `feature/<my-feature>` or `fix/<my-fix>` prefixes are recommended. Also including an issue number can be helpful.
- Follow the coding style used in the project.
- Write clear, concise commit messages.
- Add tests for new features or bug fixes when possible.
- Document any new functionality.
## Need Help?
- Join our [community](https://the-low-code-foundation.fibery.io/invite/5NtlTThnCPh2vaAk)
- Open an issue for questions or suggestions.
Thank you for helping improve OpenNoodl!