Contributing.md

Contributing to Scientist.NET

Table of Contents:

• Code of Conduct
• I just have a question
• How can i contribute?
  • Reporting bugs
  • Suggesting enhancements
  • Your first code contribution
  • Pull Requests
• Styleguides
  • Git Commit Messages
• Labels
  • Issue labels
  • Topic category labels
  • Pull request labels

Code of conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

Please report unacceptable behavior on Gitter to a maintainer.

I just have a question

Please don't file an issue to ask a question.

TODO

How can i contribute?

Reporting bugs

TODO

Suggesting enhancements

TODO

Your first code contribution

• good first issue

Pull Requests

Please follow these steps to have your contribution considered by the maintainers:

• Follow all instructions in the template
• Follow the styleguides
• After you submit your pull request, verify that all status checks are passing
  What if the status checks are failing?

  If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git commit messages

Please refer to Conventional commits

Type	Usage	Version increment
fix():	A commit which fixes or patches a bug	x.x.1
feat():	A commit which introduces a new feature	x.1.x
BREAKING CHANGE:	A commit which has BREAKING CHANGE: in the footer	1.x.x

Labels

Issue labels

Label name	Search	Description
good first issue	search	Less complex issues which would be good first issues to work on for users who want to contribute.
help wanted	search	The would appreciate help from the community in resolving these issues.

Topic category labels

Label name	Search	Description
documentation	search	Related to any type of documentation.
performance	search	Related to performance.
security	search	Related to security.

Pull request labels

Label name	Search	Description
work-in-progress	search	Pull requests which are still being worked on, more changes will follow.
needs-review	search	Pull requests which need code review, and approval from maintainers.
under-review	search	Pull requests being reviewed by maintainers.
requires-changes	search	Pull requests which need to be updated based on review comments and then reviewed again.
needs-testing	search	Pull requests which need manual testing.