mirror of https://github.com/oliverbooth/X10D
29 lines
1.6 KiB
Markdown
29 lines
1.6 KiB
Markdown
## How you can contribute
|
|
Contributions to this project are always welcome. If you spot a bug, or want to request a new extension method, open a new issue or submit a pull request.
|
|
|
|
### Pull request guidelines
|
|
This project uses C# 8.0 language features, and adheres to the following analyzers:
|
|
|
|
- Rozlynator
|
|
- FxCop
|
|
- StyleCop
|
|
|
|
There is an `.editorconfig` and an analyzer `ruleset` file included in this repository. For quick and painless pull requests, ensure that these analyzers do not throw warnings.
|
|
|
|
### Code style
|
|
Below are a few pointers to which you may refer, but keep in mind this is not an exhaustive list:
|
|
|
|
- Use C# 8.0 features where possible
|
|
- Try to ensure code is CLS-compliant
|
|
- Follow all .NET guidelines for naming conventions
|
|
- Make full use of XMLDoc and be thorough - but concise - with all documentation.
|
|
- Ensure that no line exceeds 120 characters in length
|
|
- Do NOT include file headers in any form
|
|
- Declare `using` directives within namespace scope
|
|
- Try to avoid using exceptions for flow control
|
|
|
|
### Tests
|
|
When introducing a new extension method, you must ensure that you have also defined a unit test that asserts its correct behavior. The code style guidelines and code-analysis rules apply to the `X10D.Tests` equally as much as `X10D`, although documentation may be briefer. Refer to existing tests as a guideline.
|
|
|
|
### Disclaimer
|
|
In the event of a code style violation, a pull request may left open (or closed entirely) without merging. Keep in mind this does not mean the theory or implementation of the method is inherently bad or rejected entirely (although if this is the case, it will be outlined) |