Skip to content

Conversation

baranwalayush
Copy link

  • Added the CONTRIBUTING.md file to better help the new contributors and adhere to the standard coding guidelines.

Copy link
Member

@draeger draeger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a few suggestions for improvement. Thanks for preparing that!

@@ -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!
Copy link
Member

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!

* **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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

, etc.


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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please open…

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).
* Ask to any maintainer.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or you may ask any maintainer.

@tyzerrr
Copy link
Collaborator

tyzerrr commented Sep 24, 2025

@baranwalayush Basically, LGTM.
But maybe, this file is a little bit huge size.
CONTRINUTING.md is an entry point for new contributors, so this file should be shortened as much as possible.
This repo, official golang github repo is a great example for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants