vsoch / citelang Goto Github PK
View Code? Open in Web Editor NEWmarkdown syntax and credit system for software!
Home Page: https://vsoch.github.io/citelang/getting_started/user-guide.html
License: Mozilla Public License 2.0
markdown syntax and credit system for software!
Home Page: https://vsoch.github.io/citelang/getting_started/user-guide.html
License: Mozilla Public License 2.0
The way you cite urls
Line 62 in 9fd3808
looks correct according to a number of latex faqs. However, the output isn't generating href links which makes it difficult for readers to visit the cited url.
This may have to fixed on the JOSS template but for now I suggest to use a simpler url citation scheme to enable href linking.
issue is part of openjournals/joss-reviews#4352
Describe the bug
I've been using citelang to analyze contributions for https://github.com/sylabs/singularity between v3.9.0 and 3.10.0 and am seeing some unexpected counts. The 'count' for a contributor is lower than I'd expect given the number of lines changed by their commits.
If I understand correctly, citelang is intending to count authors' contributions on a git blame
line by line basis through each commit in the specified range. I haven't had a chance to investigate the underlying cause yet, but I have been able to isolate a smaller example on the singularity repository looking at a small range of v3.9.1...v3.9.2 with a contribution from "Richard Hattersley"...
citelang contrib --start v3.9.1 --end v3.9.2 --filters ~/filters.yaml
Found 18 commits.
┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┓
┃ Name ┃ Count ┃
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━┩
│ David Trudgian │ 264 │
│ Dave Trudgian │ 2 │
│ Richard Hattersley │ 1 │
└────────────────────┴───────┘
Richard's commit in this range is sylabs/singularity@b871d84 and there are 4 lines changed here in 3 files.
The --detail
report shows citelang is only counting the change in CHANGELOG.md, and not the other files:
citelang contrib --start v3.9.1 --end v3.9.2 --filters ~/filters.yaml --detail
Found 18 commits.
Loading cached result /Users/dtrudg/Git_sylabs/singularity-analysis/.contrib/v3.9.1-v3.9.2.json
┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Name ┃ Paths ┃
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ David Trudgian │ debian/copyright: 63 │
│ │ e2e/plugin/plugin.go: 19 │
│ │ debian/s... │
│ Dave Trudgian │ CHANGELOG.md: 2 │
│ Richard Hattersley │ CHANGELOG.md: 1 │
└────────────────────┴──────────────────────────┘
To Reproduce
git clone [email protected]:sylabs/singularity singularity-analysis
cd singularity analysis
citelang contrib --start v3.9.1 --end v3.9.2 --filters ~/filters.yaml --detail
My ~/filters.yaml
is:
ignore_files:
- go.mod
- go.sum
Expected behavior
The count for Richard Hattersley
is 4... matching the 4 lines that git blame
attributes in the files modified in the commit in question:
git blame CHANGELOG.md | grep Hattersley
b871d846ca (Richard Hattersley 2021-11-25 09:29:02 +0000 12) - Correct documentation for sign command r.e. source of key index.
git blame CONTRIBUTORS.md | grep Hattersley
b871d846ca CONTRIBUTORS.md (Richard Hattersley 2021-11-25 09:29:02 +0000 88) - Richard Hattersley
git blame cmd/internal/cli/sign.go | grep Hattersley
b871d846ca cmd/internal/cli/sign.go (Richard Hattersley 2021-11-25 09:29:02 +0000 20) privKey int // -k encryption key (index from 'key list --secret') specification
b871d846ca cmd/internal/cli/sign.go (Richard Hattersley 2021-11-25 09:29:02 +0000 71) Usage: "private key to use (index from 'key list --secret')"
Version that produced the bug
0.0.28
We should be able to use the action here (under development) to then:
Describe the bug
Because citelang contrib
uses git log
with --all
to find the range of commits to analyze, it may include unrelated commits from any local git REF that has some form of shared history. E.g. if you have a 2nd remote that is a fork of your project, an upstream, or similar, and you have previously checked out a branch from it locally, then git log --all
will show commits from it, and it's not possible to filter these out later.
This is because of the meaning of --all
which is:
--all
Pretend as if all the refs in refs/, along with HEAD, are listed on
the command line as <commit>.
To Reproduce
Sorry I don't have a specific example right now... working from some rough notes of an analysis I did on my other computer which isn't with me.
Expected behavior
citelang
should not use --all
with git log
and then filter the resulting commit list.
Instead it should ask git log for the specific commit range between --start
and --end
directly e.g. git log v3.9.1..v3.9.2
.
Version that produced the bug
0.0.28
Describe the bug
Because the code is choosing random colors per table column, it can sometimes pick a color that is too close to the terminal background, making it difficult to read.
To Reproduce
Run citelang contrib ...
repeatedly, until a poor contrast color combination is chosen. E.g.
Expected behavior
A minimum contrast versus the background is used for table columns, or the random colors are picked from those that should be safe (e.g the basic 1-6, 9-14 from the 16 color terminal palette which don't include white or black to avoid clashes with most common light or dark terminal setups)
Version that produced the bug
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.