Home
Do You Tell People the Coding Standards You Expect?
  v2.0 Posted at 29/03/2016 7:28 AM by Tiago Araujo

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 ENGINEERING-GUIDELINES.md 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.png
Figure: Good Example - Adding an ENGINEERING-GUIDELINES.md to your project clearly defines the engineering practices and guidelines that must be required for contributors pull requests to be accepted

Related rules

    Do you feel this rule needs an update?

    If you want to be notified when this rule is updated, please enter your email address:

    Comments:

    Note: Social Media login for Yotpo is not working in IE or Safari, please use Chrome. We are waiting for Yotpo to fix it.