There are various ways how you can contribute to SharpDetect. It can be a bug report, feature request, documentation improvement, spreading word about the project and of course, contributing code. Moreover, you are also encouraged to ask questions when something is not clear.
- NEVER submit code that is not yours or is incompatible with project's licensing policy.
- DO NOT make significant changes, without discussing them first.
- DO NOT reorganize members, change line endings, tabs and spaces etc. Unless it is a refactoring PR.
- DO try to write idiomatic C#.
- DO prioritize existing project's code style.
- DO try to add tests when adding a new feature or fixing a bug.
It is appreciated if contributors enable the "Allow edits from maintainers" flag when opening PRs. This can be helpful when a good PR gets abandoned by the original author. In this case the PR might get finished by the maintainer of the repository.
SharpDetect is licensed under the Apache-2.0 license except for a few portions of the code that have their own license headers. Third-party libraries used by SharpDetect are distributed under their own licenses.
By submitting a PR you agree to distribute your work under the repository license. For more information, see also Github's terms of service ("inbound=outbound") rule.
When adding new files, use the license header template below. Just don't forget to substitute [yyyy] with the current year.
// Copyright [yyyy] Andrej Čižmárik and Contributors
// SPDX-License-Identifier: Apache-2.0