Mirror/MarginaliaSearch
1
0
Fork 0
mirror of https://github.com/MarginaliaSearch/MarginaliaSearch.git synced 2025-02-23 13:09:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

contributing file

Browse Source
This commit is contained in:
vlofgren 2022-10-27 19:16:30 +02:00
parent 68ec3304a3
commit 68cde1c3d8
1 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,42 @@
# Contributing
At present this is mostly a solo project, but
external contributions are very welcome.
This is a bit of a special project,
in part because a search engine isn't
like a text editor that you can just
download and tinker with; and in part
because it's as much a research project
as it is a search engine.
If you have an idea for a cool change,
send an email to <kontakt@marginalia.nu> and
we can discuss its feasibility.
Search is essentially a fractal of interesting
problems, so even if you don't have an idea,
just a skillset (really any), odds are there's
something interesting I could point you to.
## Release and branches
The search engine has a release cycle of
once per 6-8 weeks, coinciding with the crawling
cycle. Where model-breaking changes and changes to
the crawler can be introduced.
## Quick Set Up
There is a [Set Up Guide](https://git.marginalia.nu/marginalia/marginalia.nu/wiki/Setup/Search)
in the wiki. It has a small tendency to oxidize rather
rapidly since the project currently does not have a
lot of contributors to test it. If you find a problem
with the guide, email <kontakt@marginalia.nu>.
## Documentation
What documentation exists resides here:
https://git.marginalia.nu/marginalia/marginalia.nu/wiki