oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-26 10:18:48 +00:00
Code Issues
e7e8d75fba
X10D/CONTRIBUTING.md
Oliver Booth 35175807a3 Update contribution guidelines 
- Use C# 9 (instead of C# 8)
- Removed Rozlynator and StyleCop analysers
- Update line length to 130
- using directives now go outside namespace
- Enforce US english
- Enforce braces for single statements
- Implicit type where appropriate
2021-03-03 21:59:43 +00:00

1.9 KiB
Raw Blame History

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# 9.0 language features, and adheres to the FxCop analyzer. There is an .editorconfig included in this repository. For quick and painless pull requests, ensure that the analyzer does 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# 9.0 features where possible
  • Try to ensure code is CLS-compliant. Where this is not possible, decorate methods with CLSCompliantAttribute and pass false
  • 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 130 characters in length
  • Do NOT include file headers in any form
  • Declare using directives outside of namespace scope
  • Avoid using exceptions for flow control where possible
  • Use braces, even for single-statement bodies
  • Use implicit type when the type is apparent or not important
  • Use U.S. English throughout the codebase and documentation

When in doubt, follow .NET guidelines for styling.

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)