Skip to content

Commit 9d6e7e4

Browse files
Merge pull request #116 from coding-for-reproducible-research/add-license-content
Add content on licenses to Software Development Best Practices course
2 parents 2e6662a + 2dc4e65 commit 9d6e7e4

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

individual_modules/software_development_best_practices/reproducibility.ipynb

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,39 @@
4444
" - Implement testing and continuous integration.\n",
4545
"- **Documentation and Access**: Make code and data available on sharing platforms with comprehensive documentation.\n",
4646
"\n",
47+
"## Choosing and Including a License\n",
48+
"\n",
49+
"When it comes to reproducible research, including a license with your code is crucial. A license ensures that others can reuse, modify, and build upon your work legally. Without a license, the default copyright laws apply, meaning that you retain all rights to your source code and no one may reproduce, distribute, or create derivative works from your work. [GitHub License Documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)\n",
50+
"\n",
51+
"### Why Licensing is Essential\n",
52+
"\n",
53+
"- **Legal Clarity:** A license provides clear terms under which your code can be used, modified, and shared.\n",
54+
"- **Encourages Collaboration:** It allows other researchers to confidently build upon your work.\n",
55+
"- **Promotes Reproducibility:** Licensing your code ensures that others can replicate your results, learn from your methodologies, and advance the research.\n",
56+
"\n",
57+
"### How to Choose a License\n",
58+
"\n",
59+
"Selecting the right license can be daunting, but here are some resources to help you:\n",
60+
"- **[Choose a License](https://choosealicense.com/):** A great website to guide you through the process of selecting a license that fits your needs.\n",
61+
"\n",
62+
"### Adding a LICENSE File\n",
63+
"\n",
64+
"To include a license in your repository:\n",
65+
"1. **Choose a License:** Use resources like [Choose a License](https://choosealicense.com/) to select the appropriate license.\n",
66+
"2. **Add a LICENSE File:** Create a file named `LICENSE` in the root of your repository and include the text of the license you chose.\n",
67+
"3. **Reference the License in Your Documentation:** Make sure to mention the license in your README file and other relevant documentation.\n",
68+
"\n",
69+
"### Common Licenses\n",
70+
"\n",
71+
"Here are some commonly used licenses in the open-source community:\n",
72+
"- **MIT License:** A permissive license that is short and to the point. It lets people do almost anything with your project, like making and distributing closed-source versions.\n",
73+
"- **GPL License:** A copyleft license that requires anyone who distributes your code or a derivative work to make the source available under the same terms.\n",
74+
"- **Apache License:** A permissive license that also provides an express grant of patent rights from contributors to users.\n",
75+
"\n",
76+
"Including a license is a simple step that significantly enhances the impact and reach of your research by ensuring that it can be freely and legally reused. Make sure to include a LICENSE file in your repository to support open science and reproducible research.\n",
77+
"\n",
78+
"For more detailed guidance, visit our the [University of Exeter Copyright and Licences page](https://www.exeter.ac.uk/research/openresearch/oa/copyright/)\n",
79+
"\n",
4780
"## Summary Quiz"
4881
]
4982
},

0 commit comments

Comments
 (0)