Update README - Githubissues

ribose-jeffreylau commented 6 years ago

Our README needs to be clear on several things in order to help new and old contributors get up to speed:

[ ] amount of indentation used (4 space characters)
[ ] headings to use (Group, etc.)
[ ] the use of Data Structures section
[ ] the use of MSON as the default format
[ ] line endings (unix endings, not dos)
[ ] default file permissions (644)
[ ] use data type id for numeric ID, uuid for UUID. Don't use number nor string for ID purposes.
[x] few words about running the validator
[x] few words about submodules
[ ] etc.

skalee commented 6 years ago

Added "few words about running the validator" to TODO list.

skalee commented 6 years ago

I have feeling that most of the README content will be addressed to contributors. Perhaps we should extract CONTRIBUTING.adoc then?

cc: @ronaldtse @ribose-jeffreylau

ronaldtse commented 6 years ago

I’m not sure whether there would still be much content left in the README once we extract that, and it is rare for people to actually go to a separate CONTRIBUTORS file to read the rules. How about we just keep them in the README?

skalee commented 6 years ago

I'm fine with either.

ronaldtse commented 6 years ago

Let’s just keep them in the README for now then.

skalee commented 6 years ago

Added "few words about submodules" to TODO list.

riboseinc / ribose-api

Update README #27