search

TransforMap / data.transformap.co

Here you find a Node.js daemon to serve the public TransforMap web service.
https://data.transformap.co
GNU Affero General Public License v3.0
7 stars 2 forks source link

improvements to the CONTRIBUTING file #10

Closed species closed 8 years ago

species commented 8 years ago

some more documentation...

almereyda commented 8 years ago

Can we find a convention regarding use of complete grammar and orthography in documentation, especially for highly visible parts like the Contributing guidelines?

Further on the content doesn't seem a proper fit for explaining how we organize our development process. I would suggest to put the content of this diff into a file like docs/develop.md while accordingly linking to it from README.md.

species commented 8 years ago

A apologize for improper grammar, it seems that my English skills have not yet reached the required level. As this is unlikely to change in the near future, I would be happy to adopt a FLOSS grammar checking software - do you have any recommendations?

Could you add a guide which part of the documentation should go where? In fact the proper place for documentation about how to document would be the CONTRIBUTIONS file ;-)

almereyda commented 8 years ago

I will look into this and turn the contributing-improvements branch to a mergeable state.