diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e2b9c2e --- /dev/null +++ b/CONTRIBUTING.md @@ -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/` or `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! \ No newline at end of file diff --git a/README.md b/README.md index beedc02..856f22b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # OpenNoodl -OpenNoodl is a fork of the original Noodl open source code under GPL-3.0 license. OpenNoodl / Noodl is a front end React app builder with a visual programming interface. +OpenNoodl is a fork of the original Noodl open source code under GPL-3.0 license. OpenNoodl / Noodl is a front end React app builder with a visual programming interface. OpenNoodl will aim to stay entirely in sync with the original repository, including future updates to this repository. A roadmap for updates will be published soon. @@ -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. @@ -88,5 +103,5 @@ Packaged licensed under MIT: - `noodl-runtime` - `noodl-viewer-cloud` - `noodl-viewer-react` - + You can find a MIT LICENSE file in each of these packages. The rest of the repository is licensed under GPLv3.