diff --git a/README.md b/README.md index abc5c40..2bccada 100644 --- a/README.md +++ b/README.md @@ -34,3 +34,34 @@ A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marke * Seemless editing of both script file and notebook together * Support metadata in script files (currently metadata might not be saved) * Configuration of formats (metdata) + +## 🤝 Contribution + +We welcome all suggestions and improvements! If you have ideas, bug fixes, or new features, feel free to contribute. + +### How to contribute: + +1. **Fork** the repository. +2. **Create a new branch** for your feature or fix: + ```bash + git checkout -b feature/your-feature + ``` +3. Make changes and commit them: + ```bash + git commit -m "Added a new feature: your-feature" + ``` +4. Push the changes to your fork: + ```bash + git push origin feature/your-feature + ``` +5. Create a Pull Request and describe the changes you made. + +📋 Pull Request Guidelines: +* Write clean and readable code. +* Follow the existing code style of the project. +* Add comments and documentation if necessary. +* Ensure that your changes do not break existing functionality. + +Other important statements are described here: [Contributing](CONTRIBUTING.md) + +We appreciate your contribution! 🚀