-
Notifications
You must be signed in to change notification settings - Fork 18
Add CONTRIBUTING.md file #94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Contributing to SBSCL | ||
|
||
Thank you for your interest in contributing to SBSCL! If you would like to make improvements to the library, add new features that are useful to you and others, or have found a bug that you know how to fix, please open a pull request! | ||
|
||
## How to Contribute | ||
|
||
### Reporting Bugs | ||
|
||
If you find a bug, please open a new issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues) and provide the following information: | ||
|
||
* **Expected behavior:** What should happen? | ||
* **Actual behavior:** What is happening instead? | ||
* **Reproduction steps:** Clear, concise steps to reproduce the issue. | ||
* **Environment:** Your operating system, version of the project etc. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. , etc. |
||
* **Screenshots or error messages:** If applicable. | ||
|
||
### Suggesting Enhancements | ||
|
||
For feature requests or enhancements, please open a new issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues) and describe: | ||
|
||
* **The problem you are trying to solve.** | ||
* **Your proposed solution or enhancement.** | ||
* **Any alternative solutions you have considered.** | ||
|
||
### Code Contributions | ||
|
||
1. **Fork** the repository and **clone** it locally. | ||
2. **Create a new branch** for your changes: `git checkout -b your-feature-name`. | ||
3. **Make your changes** and ensure they adhere to our [Coding Style Guide Link, if applicable]. | ||
4. **Write tests** for your changes to ensure functionality and prevent regressions. | ||
5. **Commit your changes** with a clear and descriptive commit message. | ||
6. **Push your branch** to your fork: `git push origin your-feature-name`. | ||
7. **Open a Pull Request (PR)** to the upstream repository. | ||
* Provide a clear description of your changes. | ||
* Reference any related issues. | ||
|
||
## Development Setup | ||
|
||
For more information regarding the installation, refer to [INSTALL.md](INSTALL.md) | ||
|
||
## Getting Help | ||
|
||
If you have questions or need assistance, please feel free to: | ||
|
||
* Open an issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please open… |
||
* Ask to any maintainer. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Or you may ask any maintainer. |
||
|
||
We appreciate your contributions and look forward to collaborating with you! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We appreciate your interest in contributing to SBSCL! If you would like to make improvements to the library, add new useful features, or have found a bug you know how to fix, please open a pull request!