README.md 2.41 KB
Newer Older
1
# [Snowdrift.coop]
David Thomas's avatar
David Thomas committed
2

3
[![build status](https://gitlab.com/snowdrift/snowdrift/badges/master/build.svg)](https://gitlab.com/snowdrift/snowdrift/commits/master)
4

Bryan Richter's avatar
Bryan Richter committed
5
This is the software that runs the [Snowdrift.coop] website.
6
It uses the [Yesod web framework] and [Haskell] programming language.
Bryan Richter's avatar
Bryan Richter committed
7

8 9 10
Key links:

* [What is Snowdrift?]
11 12 13
* [code issues]
* [specs]
* [roadmap]
Bryan Richter's avatar
Bryan Richter committed
14

15 16
## Code repositories

17
Main repositories: [gitlab.com/snowdrift]
18

19
We also mirror the code repo on [GitHub] but prefer issues and merge requests at the main location (and we do not maintain mirrors of the separate project repos like design, legal, ops, etc.).
Bryan Richter's avatar
Bryan Richter committed
20

21
## Contributing
22

23
Snowdrift.coop welcomes contributions of all sorts.
Bryan Richter's avatar
Bryan Richter committed
24

25
Outside of coding, see our [how-to-help] wiki page.
Bryan Richter's avatar
Bryan Richter committed
26

27 28 29
For code contributions, our **[contributor guide]** covers all the steps in
detail (including notes about our development practices, basic setup, and
resources for those new to Git, Haskell, or even to programming in general). The
30
core points are:
31

32
* Follow our [build instructions] to build and test the software.
Bryan Richter's avatar
Bryan Richter committed
33

34
* File and search concrete issues/tickets/tasks in our GitLab [issues]
Bryan Richter's avatar
Bryan Richter committed
35

36 37 38
* Get in touch *any* time. Don't hesitate to ask questions, ask for help,
    provide feedback etc. Use any of our [contact options] as appropriate.
    * Note that we follow a [Code of Conduct] for all public discussions.
39

40 41 42
License
-------

43 44 45 46 47 48
Except where specified otherwise, all Snowdrift code is licensed under the
[GNU Affero General Public License](LICENSE.md) as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

Our text and graphics documents (non-program-code) are also licensed under
49
[CC BY-SA 4.0 International].
50

51
[build instructions]: BUILD.md
52
[CC BY-SA 4.0 International]: https://creativecommons.org/licenses/by-sa/4.0
53
[contributor guide]: CONTRIBUTING.md
54
[GitHub]: https://github.com/snowdriftcoop/snowdrift
Bryan Richter's avatar
Bryan Richter committed
55
[Haskell]: https://www.haskell.org/
56
[code issues]: https://gitlab.com/snowdrift/snowdrift/issues
57
[roadmap]: https://wiki.snowdrift.coop/planning
Bryan Richter's avatar
Bryan Richter committed
58 59 60
[Snowdrift.coop]: https://snowdrift.coop/
[What is Snowdrift?]: https://snowdrift.coop/about
[Yesod web framework]: http://www.yesodweb.com/
61
[gitlab.com/snowdrift]: https://gitlab.com/snowdrift/
62
[how-to-help]: https://wiki.snowdrift.coop/community/how-to-help
63 64
[Specs]: SPECS-STORIES.md
[Code of Conduct]: https://wiki.snowdrift.coop/community/conduct
65
[contact options]: https://snowdrift.coop/contact