-
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
Open
baranwalayush
wants to merge
3
commits into
draeger-lab:master
Choose a base branch
from
baranwalayush:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # Contributing to SBSCL | ||
|
|
||
| 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! | ||
|
|
||
| ## 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. | ||
| * **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). | ||
| * Or you may ask to any maintainer. | ||
|
|
||
| We appreciate your contributions and look forward to collaborating with you! | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.