search

likecoin / puttyimages-web

Website for images adopted Like protocol.
https://dev.puttyimages.com/
GNU General Public License v3.0
18 stars 10 forks source link

Add a DEVELOPMENT.md #26

Open rickmak opened 6 years ago

rickmak commented 6 years ago

The document is intended to help Opensource developer to kick-start their development easily. It should include:

  1. Overview on the system component
  2. Common operation command, for example:
    1. How to generate migration
    2. How to run subset of test
    3. How to add a new API end-point
  3. Coding guidelines
  4. Pull Request
  5. Continuous Integration
rickmak commented 6 years ago

For 3: In css, we are using http://getbem.com/naming/ refs https://github.com/likecoin/puttyimages-web/pull/32#discussion_r193970401

nwingt commented 6 years ago

For 3: CSS are formatted using http://csscomb.com/, refs #35

rickmak commented 6 years ago

For CSS guildine: https://github.com/likecoin/puttyimages-web/pull/49#pullrequestreview-128388541

Copying here

- component will have main class in the same vue files.
- The main class is relying on include and variable to maintain site-wide consistence
- There is common class across the site to apply into small componet, like button, input text.