Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thehale/git-authorship

See who wrote each line of code in your git repository with interactive reports.
https://github.com/thehale/git-authorship

copyright education git git-blame grading hacktoberfest oss-compliance reporting spdx

Last synced: about 2 months ago
JSON representation

See who wrote each line of code in your git repository with interactive reports.

Awesome Lists containing this project

README 

        






# Git-Authorship



Interactive reports showing who wrote each line of code in your git repository.



[![](https://badgen.net/github/license/thehale/git-authorship)](https://github.com/thehale/git-authorship/blob/master/LICENSE)

[![](https://badgen.net/badge/icon/Sponsor/pink?icon=github&label)](https://github.com/sponsors/thehale)

[![Joseph Hale's software engineering blog](https://jhale.dev/badges/website.svg)](https://jhale.dev)

[![](https://jhale.dev/badges/follow.svg)](https://www.linkedin.com/comm/mynetwork/discovery-see-all?usecase=PEOPLE_FOLLOWS&followMember=thehale)




```bash

pip install git-authorship



git-authorship https://github.com/USERNAME/REPOSITORY



# Open build/authorship.html in a web browser

```




![GIF demonstrating an interactive report of the authors of the cubing library

cubing.js](https://github.com/thehale/git-authorship/blob/master/docs/git-authorship-demo-cubingjs.gif?raw=true)






## Why?



Copyright is a thing, and whoever wrote the code in your repository holds an

exclusive copyright over it unless an agreement has been made otherwise. 



While `git-authorship` does not help with managing copyright agreements from

contributors (see

[cla-assistant](https://github.com/cla-assistant/cla-assistant) and its

corresponding [GitHub

Action](https://github.com/contributor-assistant/github-action) for that

functionality), it does help you clearly identify who your contributors are and

the exact lines of code they wrote.



## License

Copyright (c) 2022-2024 Joseph Hale, All Rights Reserved



Provided under the terms of the [Mozilla Public License, version 2.0](./LICENSE)



What does the MPL-2.0 license allow/require?



### TL;DR



You can use files from this project in both open source and proprietary

applications, provided you include the above attribution. However, if

you modify any code in this project, or copy blocks of it into your own

code, you must publicly share the resulting files (note, not your whole

program) under the MPL-2.0. The best way to do this is via a Pull

Request back into this project.



If you have any other questions, you may also find Mozilla's [official

FAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/) for the MPL-2.0 license

insightful.



If you dislike this license, you can contact me about negotiating a paid

contract with different terms.



**Disclaimer:** This TL;DR is just a summary. All legal questions

regarding usage of this project must be handled according to the

official terms specified in the `LICENSE` file.



### Why the MPL-2.0 license?



I believe that an open-source software license should ensure that code

can be used everywhere.



Strict copyleft licenses, like the GPL family of licenses, fail to

fulfill that vision because they only permit code to be used in other

GPL-licensed projects. Permissive licenses, like the MIT and Apache

licenses, allow code to be used everywhere but fail to prevent

proprietary or GPL-licensed projects from limiting access to any

improvements they make.



In contrast, the MPL-2.0 license allows code to be used in any software

project, while ensuring that any improvements remain available for

everyone.