mirror of
https://github.com/The-Low-Code-Foundation/OpenNoodl.git
synced 2026-01-10 14:22:53 +01:00
Added Contribution markdown file and a section in the readme.
This commit is contained in:
36
CONTRIBUTING.md
Normal file
36
CONTRIBUTING.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Contributing to OpenNoodl
|
||||
|
||||
Thank you for your interest in contributing! Here’s 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!
|
||||
15
README.md
15
README.md
@@ -40,6 +40,21 @@ If you prefer self-hosting or a local backend, while still taking advantage of t
|
||||
|
||||
See the original Noodl documentation below
|
||||
|
||||
# Contribution
|
||||
|
||||
We welcome contributions to OpenNoodl! To contribute:
|
||||
|
||||
1. **Fork the repository** and create your feature branch (`git checkout -b feature/my-feature`).
|
||||
2. **Make your changes** and follow the existing code style.
|
||||
3. **Test your changes** locally.
|
||||
4. **Commit your changes** (`git commit -am 'Add new feature'`).
|
||||
5. **Push to your branch** (`git push origin feature/my-feature`).
|
||||
6. **Open a pull request** describing your changes.
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for details and our code of conduct.
|
||||
|
||||
If you have questions, join our [community](https://the-low-code-foundation.fibery.io/invite/5NtlTThnCPh2vaAk) or open an issue.
|
||||
|
||||
# Noodl
|
||||
|
||||
[Noodl](https://noodl.net) is a low-code platform where designers and developers build custom applications and experiences. Designed as a visual programming environment, it aims to expedite your development process. It promotes the swift and efficient creation of applications, requiring minimal coding knowledge.
|
||||
|
||||
Reference in New Issue
Block a user