Create CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to GPU-Jupyter
+
+Thank you for your interest in contributing to GPU-Jupyter, a project by [iot-salzburg](https://github.com/iot-salzburg) that leverages the flexibility of JupyterLab with the power of NVIDIA GPUs. This guide will help you get started with contributing to this project.
+
+## Getting Started
+
+1. **Familiarize Yourself with the Project**: Visit the [GPU-Jupyter GitHub repository](https://github.com/iot-salzburg/gpu-jupyter) to understand the project's scope and existing codebase.
+
+2. **Set Up Your Environment**: Ensure you have a working setup with JupyterLab and NVIDIA GPU capabilities to test your contributions effectively.
+
+## How to Contribute
+
+1. **Fork the Repository**: Start by forking the [GPU-Jupyter repository](https://github.com/iot-salzburg/gpu-jupyter).
+
+2. **Create a Branch**: Create a branch in your fork for each new feature or improvement.
+
+3. **Commit Your Changes**: Make your changes in your branch and commit them with clear, descriptive commit messages.
+
+4. **Write or Update Tests**: If you add new features or fix bugs, write new tests or update existing ones to reflect your changes.
+
+5. **Follow Code Standards**: Ensure your code adheres to the coding standards used in GPU-Jupyter (e.g., PEP 8 for Python, adapt no files in `.build`).
+
+6. **Document Your Changes**: Update the README or documentation if necessary, especially if you're adding new features or changing how the project is used.
+
+7. **Submit a Pull Request**: Once your changes are ready, submit a pull request to the main GPU-Jupyter repository.
+
+## Reporting Issues
+
+- **Use GitHub Issues**: Report bugs or suggest features by creating an issue in the GPU-Jupyter repository.
+- **Provide Detailed Information**: Include as much detail as possible in your issue reports, such as steps to reproduce the bug or detailed descriptions of the proposed feature.
+
+## Community Guidelines
+
+- **Respectful Communication**: Always communicate respectfully with other contributors and maintainers.
+- **Collaborative Mindset**: Be open to feedback and willing to collaborate with others on solutions.
+- **Inclusive Environment**: Strive to foster an inclusive environment where contributors of all backgrounds feel welcome.
+
+## Questions?
+
+If you have any questions or need further guidance, feel free to reach out to the maintainers or the community on the project's GitHub page.
+
+---
+
+We look forward to your contributions to GPU-Jupyter and thank you for supporting this project!
+
+---
+
+*This CONTRIBUTING.md is tailored specifically for the iot-salzburg/GPU-Jupyter project. For more information, visit the [GPU-Jupyter GitHub repository](https://github.com/iot-salzburg/gpu-jupyter).*