2014-04-08 19:37:22 +00:00
|
|
|
Help make git-annex better!
|
|
|
|
|
|
2018-11-05 19:07:14 +00:00
|
|
|
## user support
|
|
|
|
|
|
2024-02-25 14:21:41 +00:00
|
|
|
Hang out in git-annex support areas and answer users' questions.
|
2018-11-05 19:07:14 +00:00
|
|
|
Don't be afraid to get an answer not 100% right, but avoid wild guesses.
|
|
|
|
|
If you understand the basics of how git-annex works and know how to use it,
|
|
|
|
|
you are ahead of many users, and can help them out tremendously.
|
|
|
|
|
|
2014-05-17 17:29:35 +00:00
|
|
|
## wiki gardening
|
|
|
|
|
|
|
|
|
|
This website is a wiki, so you can edit and improve any page.
|
|
|
|
|
|
|
|
|
|
Or, write a [[new_tip|tips]] explaining how to accomplish something with
|
|
|
|
|
git-annex.
|
|
|
|
|
|
2016-11-02 15:01:33 +00:00
|
|
|
## advanced wiki editing
|
|
|
|
|
|
|
|
|
|
To make larger changes to the website, you can
|
|
|
|
|
`git clone git://git-annex.branchable.com/ git-annex` and will find the
|
|
|
|
|
whole website source in `doc/`.
|
|
|
|
|
|
|
|
|
|
You can even `git push` doc-only changes back without authentication,
|
|
|
|
|
since it is a wiki!
|
|
|
|
|
|
2014-05-17 17:29:35 +00:00
|
|
|
## bug triage
|
|
|
|
|
|
|
|
|
|
People often file [[bugs]] on git-annex that are easily resolved by helping
|
|
|
|
|
them with a problem, and perhaps writing some documentation.
|
|
|
|
|
|
|
|
|
|
Many bugs are also filed without enough information
|
|
|
|
|
to reproduce the problem, and need to be tagged moreinfo and a comment
|
|
|
|
|
posted asking the submitter for details.
|
|
|
|
|
|
2018-11-05 18:38:32 +00:00
|
|
|
Once a bug is confirmed to be reproducible, it becomes a lot easier to fix.
|
|
|
|
|
So it's very helpful to highlight such bugs.
|
|
|
|
|
|
2014-05-17 17:29:35 +00:00
|
|
|
Joey spends a lot of time dealing with this kind of bug triage. If you can
|
2018-11-05 18:38:32 +00:00
|
|
|
take the time to pick a bug that is not tagged as "confirmed" or "moreinfo"
|
2014-05-30 21:11:34 +00:00
|
|
|
from the list of [[bugs]], try to reproduce it and follow up either
|
2014-05-17 17:29:35 +00:00
|
|
|
confirming that the problem exists, or asking the submitter for more info,
|
|
|
|
|
you'll make Joey more productive!
|
|
|
|
|
|
2018-11-05 18:38:32 +00:00
|
|
|
You can add and modify tags by editing the bug's page with this wiki code:
|
|
|
|
|
|
|
|
|
|
\[[!taglink confirmed]]
|
|
|
|
|
\[[!taglink moreinfo]]
|
|
|
|
|
|
2014-05-17 17:29:35 +00:00
|
|
|
## code contributions
|
|
|
|
|
|
2014-09-16 19:05:12 +00:00
|
|
|
[[download]] the source code, [[build|install/fromsource]] it
|
|
|
|
|
and send patches!
|
2014-05-17 17:29:35 +00:00
|
|
|
|
|
|
|
|
If you know Haskell, git-annex has lots of Haskell code that
|
|
|
|
|
could be improved. See the [[coding_style]] and have at it.
|
|
|
|
|
|
|
|
|
|
If you don't know Haskell, git-annex has many other coding opportunities.
|
2018-11-05 18:38:32 +00:00
|
|
|
You could work to improve the Javascript and CSS of the git-annex webapp,
|
|
|
|
|
or work on porting libraries needed by the Windows port.
|
2014-04-08 22:52:35 +00:00
|
|
|
|
2016-11-02 15:01:33 +00:00
|
|
|
To send patches, either include the patch in a [[bug|bugs]] report (small
|
|
|
|
|
patch) or put up a branch in a git repository containing your changes.
|
|
|
|
|
|
2024-03-18 20:57:54 +00:00
|
|
|
[Policy on AI generated content](https://joeyh.name/blog/entry/policy_on_adding_AI_generated_content_to_my_software_projects/)
|
|
|
|
|
(Summary: It's welcome! But see the page for important details.)
|
|
|
|
|
|
2016-11-02 15:01:33 +00:00
|
|
|
## learning some Haskell
|
|
|
|
|
|
|
|
|
|
Want to learn some Haskell to get hacking on git-annex?
|
|
|
|
|
|
|
|
|
|
As Haskell programs go, git-annex does not use too many advanced features.
|
|
|
|
|
[Learn You A Haskell](http://learnyouahaskell.com/) will teach you enough
|
|
|
|
|
to get started.
|
|
|
|
|
|
2020-01-29 16:52:22 +00:00
|
|
|
Of course git-annex does use monads, and particularly the `Annex` monad
|
2016-11-02 15:01:33 +00:00
|
|
|
which gives access to its state about the git repository as well as
|
|
|
|
|
lower-level IO.
|
