From 05f7900a0bb0eb53ce7194b456c0e540f99ab4ca Mon Sep 17 00:00:00 2001 From: Chris Date: Sat, 16 Dec 2023 10:17:24 +0100 Subject: [PATCH 1/4] Create CONTRIBUTING.md --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a678268 --- /dev/null +++ b/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).* From 0fa5116cec798bbf941506de3bebd5d9c7126a48 Mon Sep 17 00:00:00 2001 From: Chris Date: Sat, 16 Dec 2023 10:23:34 +0100 Subject: [PATCH 2/4] Update issue templates --- .github/ISSUE_TEMPLATE/issue-report.md | 51 ++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue-report.md diff --git a/.github/ISSUE_TEMPLATE/issue-report.md b/.github/ISSUE_TEMPLATE/issue-report.md new file mode 100644 index 0000000..518ffe3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-report.md @@ -0,0 +1,51 @@ +--- +name: Issue report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +# GPU-Jupyter Issue Report + +Thank you for taking the time to report a bug for the GPU-Jupyter project. Your feedback is valuable in helping us maintain and improve the project. Please fill out this report with as much detail as possible. + +## Issue Description + +**Describe the issue** +A clear and concise description of the issue. + +**To Reproduce** +Steps to reproduce the behavior: + +**Expected Behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +## Environment + +**Operating System:** +Provide details about the operating system you are using (e.g., Windows, macOS, Linux distribution). + +**NVIDIA GPU and CUDA version Details:** +Provide details about the NVIDIA GPU, driver versions and CUDA version you are using (e.g., model, driver version `nvidia-smi` and `nvcc --version`). + +**GPU-Jupyter Version:** +Specify the version of GPU-Jupyter you are using. + +**Docker command and parameters:** +Specify the Docker command you are running. + +**Browser (if applicable):** +Specify the browser and version (e.g., Chrome, Firefox). + +## Additional Context + +Add any other context about the problem here, such as specific configurations or circumstances under which the bug occurs. + +--- + +*Please ensure that you have checked the existing issues to avoid duplicates. Thank you for contributing to making GPU-Jupyter better!* From ab39dd5ff8ce6b8716f2c9d581712ce5a19cf1bf Mon Sep 17 00:00:00 2001 From: Chris Date: Sat, 16 Dec 2023 10:25:38 +0100 Subject: [PATCH 3/4] Add feature template --- .github/ISSUE_TEMPLATE/feature_request.md | 38 +++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..d0798bd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,38 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +# GPU-Jupyter Feature Request + +Thank you for your interest in enhancing GPU-Jupyter. We appreciate your ideas and feedback. Please fill out this brief form to help us understand your feature request. + +## Feature Description + +**Title** +A concise title that summarizes the feature request. + +**Detailed Description** +Provide a detailed description of the feature you're proposing. Explain how it would function and its intended use case. + +**Benefits** +Describe the benefits this feature would bring to GPU-Jupyter users. + +**Possible Implementation** +(Optional) If you have ideas about how this feature could be implemented, please share them here. + +## Additional Information + +**Screenshots/Illustrations** +(Optional) If you have any visual representations of your feature, please include them. + +**References** +(Optional) Include any references to similar features in other projects or documentation that might be helpful. + +--- + +*We value your contribution and look forward to exploring new features for GPU-Jupyter. Thank you for your support!* From 0aa2fac7f093f7b500a1c8225a4ed855211464f5 Mon Sep 17 00:00:00 2001 From: Chris Date: Sat, 16 Dec 2023 10:31:55 +0100 Subject: [PATCH 4/4] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d173d8a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,33 @@ +# Code of Conduct for GPU-Jupyter + +## Our Commitment + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers of GPU-Jupyter, commit to making participation in our project and our community a harassment-free experience for everyone. This is in line with our goal of providing a robust platform for data science and machine learning workflows, leveraging the power of NVIDIA GPUs and JupyterLab. + +## Standards + +We aim to create a positive environment. Therefore, we encourage the following behavior: + +- **Inclusive Language**: Use welcoming and inclusive language. +- **Respect Different Viewpoints**: Respect differing viewpoints and experiences. +- **Graceful Acceptance of Constructive Criticism**: Accept and offer constructive criticism. +- **Focus on Community Well-being**: Prioritize the well-being and advancement of the community. +- **Empathy and Kindness**: Show empathy and kindness towards other community members. + +Examples of unacceptable behavior include: + +- **Harassment in Any Form**: Posting trolling, insulting, derogatory comments, or personal or political attacks. +- **Publishing Others' Private Information**: Publishing others' private information without explicit permission. +- **Other Unprofessional Conduct**: Conduct which could reasonably be considered inappropriate in a professional setting. + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, and is tailored to meet the specific needs of the GPU-Jupyter project.