๐ญ Something that always needs to be done, is documenting code. We all seem to lack behind in this task. So, why not take half an hour today to write a short documentation on one of your repositories? Just as a start? Read more about documenting code here ๐
https://sslarch.github.io/maintainathon/resources#writing-comprehensive-documentation
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
๐ Do you publish your code properly?
While commercial platforms like GitHub and GitLab may provide very useful collaboration features, they should not be trusted as long-term stewards of software or data. Professional archives are better suited for this. There are some options. Check out our small intro ๐ https://sslarch.github.io/maintainathon/resources#archive-your-code-in-a-long-term-repository
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
โ Check out our resources page for a very simple practical guide on how to write unit tests, written by @lsteinmann: http://sslarch.github.io/maintainathon/resources#test-your-codes-functionality
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
โ Good tests help you make sure that your script, package, or software is maintainable and functional, and does exactly what you want it to. They are also a great form of documentation, communicating what you expected from your functions and methods to others who may want to reuse your code.
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
โ Testing your code involves including additional logic to test whether your code is operating as you expect it to. Aside from supporting users with different computational environments, theyโre a great way to slow down and think about the code youโre writing and whether it supports your goals.
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
๐ Plenty of research has been done to encourage better software engineering practices, among archaeological and non-archaeological researchers alike. We compiled a brief list of papers addressing challenges in this space, and we encourage you to take a gander.
http://sslarch.github.io/maintainathon/resources#further-reading
Special thanks to @gvwilson for helping compile this reading list โบ๏ธ
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
๐พ Remember: effective roadmaps have tangible and measurable outcomes, and are comprised of tasks that can actually be acted upon! Check out the SMART guidelines
Specific
Measurable
Achievable
Relevant
Time-bound
(https://en.wikipedia.org/wiki/SMART_criteria) if you would like guidance on how to do this.
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
๐พ A roadmap is a documented plan of action that structures future work. Having a checklist of things to do (and already done!) can help garner momentum while also making your plans more transparent for prospective users.
Roadmaps should document what features are planned over short- and long-term, outline what steps need to be taken to achieve these goals, and delegate/credit work to specific individuals.
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
๐ Check: Is your code properly licensed? โ๏ธ
If not, go and give one of your repositories a license now! It is such a quick and easy way to improve the re-usability of your contribution. Have a look at our small introduction, if you need guidance ๐ https://sslarch.github.io/maintainathon/resources#add-a-license
#DigiArchMaintainathon #DigitalArchaeology #ComputationalArchaeology #Maintainathon
CAA SSLA