Do You Tell People the Coding Standards You Expect?

Last updated by TiagoAraujo about 8 years ago.See history

The code within your solution should be consistent. (We all know that)

In an open source project the easy way to ensure that all developers share and are aware of the expectations is to include and markdown file that includes important technical considerations like:

  • Copyright header requirements
  • Approved external dependencies
  • Coding guidelines and standards
  • Source control requirements
  • Branching strategy
  • Solution and project folder structure and naming
  • Unit testing requirements

guidelines opensource
Figure: Good Example - Adding an to your project clearly defines the engineering practices and guidelines that must be required for contributors pull requests to be accepted

We open source. Powered by GitHub