Open Collaboration Guide
2021-04-16
Welcome
I didn't have time to write a short letter, so I wrote a long one instead. — Mark Twain
For collaborators who do not write code, the general Introduction contains a Simple Introduction focusing on documentation tools only. Contributors with no coding experience and ambition will likely work with data curation and documentation, publications which is equally important to developing code. You must be familiar with our developers naming conventions, because we automate research: their programs create data tables, visualizations, maps, blogposts, even books following this vocabulary.
Most of this long-form documentation is intended for collaborators who write code to acquire data, store data, create applications such a statistics, or machine learning applications, and who help us publish data.
Open collaboration is an agile project management method that breaks up the tasks to small, independent, decentralized acts that can be performed by individuals or research groups. It requires a solid shared knowledge base and a very high quality documentation. This collaboration guide serves two goals: to practice this documentation workflow, and to create a continuously improved documentation for our collaboration methods and practices.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. We ask you to contribute to the growth of our open collaboration, and we would like to contribute to your growth. We would love to work with your favorite data, add your inspiring reading and listening recommendations to this guide and cite your work throughout or publications.
You can edit yourselft this guide on github. The html, epub, docx and pdf versions can be found on open-collaboration-guide.dataobservatory.eu. The pdf is not working.