Develop your code in publicly accessible repositories with version control
Why is this important?
constitutes a backup
enables collaboration
facilitates always having a working version of your software
facilitate public review of code, thus catching any errors early on
for advanced users, sites like GitHub:
- provide project management tools
- provide an issue tracker
- enable integration with code quality checker tools
- enable integration with automatic tests (avoids regression)
Help me choose
Lorem Ipsum is simply dummy text of the printing and
typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown
printer took a galley of type and scrambled it to make a type
specimen book. It has survived not only five centuries, but
also the leap into electronic typesetting, remaining
essentially unchanged. It was popularised in
Add a license
Why is this important?
You, as the creator of your software, own the copyright for your software
(although you may have waived those rights and transferred them to your
employer).
Note that if your software does not explicitly include a license, others can not
(legally) use your software, even when it is available online via platforms such
as GitHub or BitBucket.
(some text about permissive licenses)
(some text about using a pre-existing license)
Help me choose
Lorem Ipsum is simply dummy text of the printing and
typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown
printer took a galley of type and scrambled it to make a type
specimen book. It has survived not only five centuries, but
also the leap into electronic typesetting, remaining
essentially unchanged. It was popularised in
Register your code in a community registry
Why is this important?
software is often difficult to find; many communities have some kind of registry where you can register your software
package.; provides metadata to promote indexing by search engines; software citation is not trivial
Help me choose
Lorem Ipsum is simply dummy text of the printing and
typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown
printer took a galley of type and scrambled it to make a type
specimen book. It has survived not only five centuries, but
also the leap into electronic typesetting, remaining
essentially unchanged. It was popularised in
Enable citation of the software
Why is this important?
software is an integral part of the scientific output.
for reproducibility, it is important to be able to reference the exact copy of the software, as used in a given study.
note that just pointing to a github repo is insufficient; you need a persistent identifier, and a persistent copy of your software stored for long-ter archiving.
Some parties that can provide such long term archiving are zenodo, figshare, etc.
Help me choose
Lorem Ipsum is simply dummy text of the printing and
typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown
printer took a galley of type and scrambled it to make a type
specimen book. It has survived not only five centuries, but
also the leap into electronic typesetting, remaining
essentially unchanged. It was popularised in
Use a software quality checklist
Why is this important?
there are many software checklists that aim to help you develop clean, reusable code
Help me choose
Lorem Ipsum is simply dummy text of the printing and
typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown
printer took a galley of type and scrambled it to make a type
specimen book. It has survived not only five centuries, but
also the leap into electronic typesetting, remaining
essentially unchanged. It was popularised in