libgit2 / libgit2/libgit2sharp
Make the Linux/MacOSX experience slightly more delightful
Open
Nobody has claimed this yet.
Easy fix
Up for grabs
- Dominant language
- C#
- Stars
- 3.5k
- Forks
- 925
- PR merge metrics
- No merged PRs in 30d
Description
#786 brings under the light the fact that there's still a huge room for improvment regarding the following topics
- How to build libgit2
- How to run the tests against the generated binaries
Currently, all of the above is being automagically done by the build.libgit2sharp.sh script.
I can think of two options:
- Add some documentation in the script header describing what the script does, where the binaries are generated
- Break up the script into two scripts (ie.
buildandruntests)
There are certainly others ways to solve this.
Thoughts?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading build.libgit2sharp.sh and tracing how it builds libgit2, generates binaries, and runs tests on Linux and macOS. Confirm with maintainers whether the intended outcome is script documentation or separate build and test scripts; done means the workflow is clearly explained or cleanly separated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- build-system, developer-experience
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100