|
| 1 | +# Contributing to SpectrumX Data System Gateway and SDK |
| 2 | + |
| 3 | +First off, thanks for taking the time to contribute! ❤️ |
| 4 | + |
| 5 | +All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 |
| 6 | + |
| 7 | ++ [Contributing to SpectrumX Data System Gateway and SDK](#contributing-to-spectrumx-data-system-gateway-and-sdk) |
| 8 | + + [Documentation](#documentation) |
| 9 | + + [I Have a Question](#i-have-a-question) |
| 10 | + + [I Want To Contribute](#i-want-to-contribute) |
| 11 | + + [Reporting Bugs](#reporting-bugs) |
| 12 | + + [Suggesting Enhancements](#suggesting-enhancements) |
| 13 | + + [Attribution](#attribution) |
| 14 | + |
| 15 | +## Documentation |
| 16 | + |
| 17 | +Quick links: |
| 18 | + |
| 19 | ++ [SDS Readme](https://sds.crc.nd.edu/api/v1/docs/) |
| 20 | ++ [Gateway | API Reference](https://sds.crc.nd.edu/api/v1/docs/) |
| 21 | ++ [Gateway | Developer's Guide](https://github.com/spectrumx/sds-code/blob/master/gateway/README.md) |
| 22 | ++ [Python SDK | Usage Guide](https://github.com/spectrumx/sds-code/tree/master/sdk/docs) |
| 23 | ++ [Python SDK | Developer's Guide](https://github.com/spectrumx/sds-code/tree/master/sdk) |
| 24 | ++ Related repositories: |
| 25 | + + [SVI Repo](https://github.com/spectrumx/svi-code/) |
| 26 | + + [Schema Definitions Repo](https://github.com/spectrumx/schema-definitions/) |
| 27 | + |
| 28 | +## I Have a Question |
| 29 | + |
| 30 | +> If you want to ask a question, we assume that you have read the available [documentation](#documentation) and [searched the existing issues](#reporting-bugs). |
| 31 | +
|
| 32 | +Before you ask a question: |
| 33 | + |
| 34 | ++ Search for existing [Issues](https://github.com/spectrumx/sds-code/issues) that might help you. |
| 35 | + + In case you have found a suitable issue and still need clarification, you can write your question in this issue. |
| 36 | ++ Search the internet for answers if it might not be specific to this project. |
| 37 | + |
| 38 | +If you still have questions, please follow these steps: |
| 39 | + |
| 40 | ++ Open an [Issue](https://github.com/spectrumx/sds-code/issues/new). |
| 41 | ++ Provide as much context as you can about what you're running into. |
| 42 | ++ Provide project, operating system, and versions, depending on what seems relevant. |
| 43 | + |
| 44 | +## I Want To Contribute |
| 45 | + |
| 46 | +> ### Legal Notice <!-- omit in toc --> |
| 47 | +> |
| 48 | +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. |
| 49 | +
|
| 50 | +### Reporting Bugs |
| 51 | + |
| 52 | +> [!IMPORTANT] |
| 53 | +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email: |
| 54 | +> |
| 55 | +> + `crc-sds-list [·at·] nd.edu`. |
| 56 | +
|
| 57 | +<!-- omit in toc --> |
| 58 | +#### Before Submitting a Bug Report |
| 59 | + |
| 60 | +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. |
| 61 | + |
| 62 | ++ Make sure that you are using the latest version. |
| 63 | ++ Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](#documentation). If you are looking for support, you might want to check [this section](#i-have-a-question)). |
| 64 | ++ To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/spectrumx/sds-code/issues?q=label%3Abug). |
| 65 | ++ Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. |
| 66 | ++ Collect information about the bug: |
| 67 | ++ Stack trace (Traceback) |
| 68 | ++ OS, Platform and Version (Windows, Linux, macOS, x86, ARM) |
| 69 | ++ Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. |
| 70 | ++ Possibly your input and the output |
| 71 | ++ Can you reliably reproduce the issue? And can you also reproduce it with older versions? |
| 72 | + |
| 73 | +<!-- omit in toc --> |
| 74 | +#### How Do I Submit a Good Bug Report? |
| 75 | + |
| 76 | +We use GitHub issues to track bugs and errors. If you run into an issue with the project: |
| 77 | + |
| 78 | ++ Open an [Issue](https://github.com/spectrumx/sds-code/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) |
| 79 | ++ Explain the behavior you would expect and the actual behavior. |
| 80 | ++ Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. |
| 81 | ++ Provide the information you collected in the previous section. |
| 82 | + |
| 83 | +Once it's filed: |
| 84 | + |
| 85 | ++ The project team will triage the issue and label it accordingly. |
| 86 | ++ A team member will try to reproduce the issue and we will keep in touch to get or provide additional information as needed. |
| 87 | + |
| 88 | +### Suggesting Enhancements |
| 89 | + |
| 90 | +This section guides you through submitting an enhancement suggestion for SpectrumX Gateway and SDK, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. |
| 91 | + |
| 92 | +<!-- omit in toc --> |
| 93 | +#### Before Submitting an Enhancement |
| 94 | + |
| 95 | ++ Make sure that you are using the latest version. |
| 96 | ++ Read the [documentation](#documentation) carefully and find out if the functionality is already covered, maybe by an individual configuration. |
| 97 | ++ [Search](https://github.com/spectrumx/sds-code/issues) for previously proposed enhancements. If it has, add a comment to the existing issue instead of opening a new one. |
| 98 | ++ Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. |
| 99 | + |
| 100 | +<!-- omit in toc --> |
| 101 | +#### How Do I Submit a Good Enhancement Suggestion? |
| 102 | + |
| 103 | +Enhancement suggestions are tracked as [GitHub issues](https://github.com/spectrumx/sds-code/issues). |
| 104 | + |
| 105 | ++ Use a **clear and descriptive title** for the issue to identify the suggestion. |
| 106 | ++ Provide a **step-by-step description of the suggested enhancement** in as many details as possible. |
| 107 | ++ **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. |
| 108 | ++ You may want to **include screenshots or screen recordings**. You can use one of the following tools: |
| 109 | + + The built-in [screen recorder](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) in GNOME. |
| 110 | + + The built-in [spectacle](https://apps.kde.org/spectacle/) in KDE Wayland. |
| 111 | + + [OBS](https://obsproject.com/download) on Linux, Windows and macOS. |
| 112 | ++ **Explain why this enhancement would be useful** to most SpectrumX Gateway and SDK users. You may also want to point out the other projects that solved it better and which could serve as inspiration. |
| 113 | + |
| 114 | +## Attribution |
| 115 | + |
| 116 | +This guide is based on the [contributing.md](https://contributing.md/generator)! |
0 commit comments