Skip to content

web search done right

update contributing guidelines

Mikkel Denker4da1987fe556
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fd5d7bae..21b0f3ba 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,7 +1,14 @@
+# Background
+Stract is an open source company that tries to fix search.
+All our code is licensed under AGPLv3.
+The main idea is that if we ever do anything that is against the best interest of the users, someone else can take our code and do better. You can read more about the [thought process here](https://github.com/StractOrg/stract/discussions/150#discussioncomment-8476851) if you are interested.
+
+Please don't contribute unless you feel comfortable doing so.
+
# Contributing to Stract
There are many ways to contribute to Stract.
Code contribution are welcome of course, but also
-bug reports, feature request, and evangelizing are as valuable.
+bug reports, feature request, and evangelizing are just as valuable.
# Submitting a PR
Check if your issue is already listed [github](https://github.com/StractOrg/stract/issues).
@@ -11,19 +18,20 @@ PR is not a waste of your time.
Please add the following phrase at the end of your commit `Closes #<Issue Number>`.
It will automatically link your PR in the issue page. Also, once your PR is merged, it will
-closes the issue. If your PR only partially addresses the issue and you would like to
+close the issue. If your PR only partially addresses the issue, and you would like to
keep it open, just write `See #<Issue Number>`.
Feel free to send your contribution in an unfinished state to get early feedback.
In that case, simply mark the PR with the tag [WIP] (standing for work in progress).
# Signing the CLA
-Stract is an opensource project licensed a AGPLv3.
-
Contributors are required to sign a Contributor License Agreement.
The process is simple and fast. Upon your first pull request, you will be prompted to
[sign our CLA by visiting this link](https://cla-assistant.io/StractOrg/stract).
+We ask you to sign the CLA as it makes it [easier for us to sue a competitor](https://softwareengineering.stackexchange.com/questions/168020/how-signing-out-a-cla-prevents-legal-issues-in-open-source-projects/168026#168026)
+if they take our code without making theirs open source, which would breach the AGPLv3 license.
+
# Development
## Setup
* Install rust by following the steps outlined [here](https://www.rust-lang.org/tools/install)