Instructions for Contributors

[mlagisz]

• Check and post workflow diagram?
• Add some screenshots or more detailed instructions for working with GoogleSheet template?
• In "Instructions for Contributors" add a note (e.g. in bracket) that although we say "one" it could be two people working togather (e.g. what we did in the original Polish translation).
• In "If a .json for your language DOES already exist:" section, "So that the Github repository gets updated, create a pull request by clicking on BLAH BLAH" needs to be deleted. Especially because the next point has instructions on what else needs to go in the file, so it should be done before creating any pull requests.
• The final point is "Generate a pull request", which also needs to be removed, as the next section is about validating the file and then the next is to notify project leads
• In "Validate your .json file", add a point on what to do if it fails.
• In "Send us your .json file, or upload it yourself", clarify how to send the file (e.g. email address)
• In "Send us your .json file, or upload it yourself", complete "If you’re familiar with Github," point and delete "Create the json file if it doesn’t already exist" and link with the next point "Create the pull request" and add more details.
• In "Contributing to other facets of the project (we’d love your help!)", just list all the points as potential and ask to get in touch (e.g. email address).
• In "Co-authorship (or, should that be co-contributorship? 😀)", complete point "A substantial contribution can be achieved by performing any X or more of the tasks listed below" (maybe move some of the points from the list above), delete "Additional contribution oportunities may be available."
• For "Help write [the journal article about this project]" please outline some of your expectations on how this should be organised (e.g. you creating the outline and letting people to write one or more paragraphs", or you drafting and then people editing, or people proposing to make tables/figures and doing this after your approval... Thi sis tricky for asynchronous project so it is good to have some framework in place.