Git Blame Nemesis

Find and git blame all files modified by author

---

• ⬆️ Top of Document

• 🏗️ Requirements

  • Git Submodules
  • Package manager applications

• ⚡ Quick Start

  • Clone
  • Install
  • Print usage

• 🧰 Usage

• 🗒 Notes

• 📈 Contributing

  • 🔱 Forking
  • 💱 Sponsor

• 📇 Attribution

• ⚖️ Licensing

---

Requirements

Prerequisites and/or dependencies that this project needs to function properly

---

Git Submodules

This repository makes use of Git Submodules to track dependencies, to avoid incomplete downloads clone with the --recurse-submodules option...

git clone --recurse-submodules [email protected]:git-utilities/git-blame-nemesis.git

To update tracked Git Submodules issue the following commands...

git pull

git submodule update --init --merge --recursive

To force upgrade of Git Submodules...

git submodule update --init --merge --recursive --remote

Note, forcing and update of Git Submodule tracked dependencies may cause instabilities and/or merge conflicts; if however everything operates as expected after an update please consider submitting a Pull Request.

---

Package manager applications

Certain things be required for error-free installation of this project

• help2man → Conversion tool to create man files

Arch

sudo pacman -S help2man

Debian

sudo apt-get install help2man

---

Quick Start

Perhaps as easy as one, 2.0,...

---

Clone

Download source code via Git

mkdir -vp ~/git/hub/git-utilities

cd ~/git/hub/git-utilities

git clone --recurse-submodules https://github.com/git-utilities/git-blame-nemesis

---

Install

How to install from Git repository

cd ~/git/hub/git-utilities/git-blame-nemesis

make config

vim .config-make

make install

---

Print usage

How to get help for git-blame-nemesis

man git-blame-nemesis

git-blame-nemesis --help

---

Usage

How to utilize this repository

• Change current working directory to a Git repository

cd ~/git/tor/arti

• Iterate over files that an author has committed

git-blame-nemesis --author S0AndS0

• At each commit hash and file found a prompt will be displayed

[Enter] git blame 2333659a maint/add_warning.py

Note inputs of q or n will terminate script, and keyboard shortcuts such as Ctrl ^ c should also function to stop blaming

---

Notes

Additional things to keep in mind when developing

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

---

Contributing

Options for contributing to git-blame-nemesis and git-utilities

---

Forking

Tips for forking git-blame-nemesis

Start making a Fork of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is [email protected]:<NAME>/<REPO>.git...

cd ~/git/hub/git-utilities/git-blame-nemesis

git remote add fork [email protected]:<NAME>/git-blame-nemesis.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/git-utilities/git-blame-nemesis


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Methods for financially supporting git-utilities that maintains git-blame-nemesis

Thanks for even considering it!

Via Liberapay you may on a repeating basis.

Regardless of if you're able to financially support projects such as git-blame-nemesis that git-utilities maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

Resources that where helpful in building this project so far.

• GitHub -- github-utilities/make-readme
• StackOverflow -- List all developers on a project in Git
• StackOverflow -- Multi Level Bash Completion

---

License

Legal side of Open Source

Find and git blame all files modified by author
Copyright (C) 2023 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.