Closed khaeru closed 4 years ago
Hello! I'm a new technical writer looking to grow my experience by contributing to project documentation. I'd be happy to help with your project if I can!
Created #202
@JamesFrierson1 thanks for the interest. To expand on this:
- Specific steps for adding tutorials, including those accompanying new features or
message_ix.tools
. These would include:
- Conforming to the tutorial style guide developed by @behnam2015 @OFR-IIASA and others.
- Adding a line to test_tutorials.py so that the parametrized test function runs the tutorial (as noted at #196).
…here is a brief/unedited set of notes from our colleagues towards that style guide. It would be great to include these in #202 so that it will close this issue. Please feel free to ask any questions you need for context.
Hi @khaeru thank you for the additional info! I'll be happy to make a pass at adding this and will comment here if I have any questions
Finished incorporating your notes. Please let me know if you see any potential improvements 👍
Closed via #230.
The contributor guidelines in the documentation include this short section on “Coding style”, but could be expanded to include:
message_ix.tools
. These would include: