emulsify-ds / compound

Compound is the default component collection for Emulsify
https://emulsify-ds.github.io/compound/
GNU General Public License v2.0
12 stars 12 forks source link

Add important information to the README #67

Open mcortes19 opened 1 year ago

mcortes19 commented 1 year ago

Expected Behavior

As a new contributor I need to have all the information related to established code conventions (variable naming, comment structure, etc) by doing this, reviewers can focus on the functionality instead of requesting changes related to the look of the code

Current Behavior

As a new contributor there's a big chance to get my PR rejected due to don't know code conventions for the project

Possible Solution

Add to the README file the "established code conventions"