-
Notifications
You must be signed in to change notification settings - Fork 3
/
contribute.html
114 lines (96 loc) · 4.48 KB
/
contribute.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
---
title: Contribute
description: How to contribute to the Queryverse
---
<div class="content">
<section>
<div class="container flex">
<div class="text editable">
<p>A large project like Queryverse requires a lot of work, and we welcome
support in whatever from from anyone. If you want to help out, here are
some concrete ideas.</p>
</div>
</div>
</section>
<section>
<div class="container flex">
<div class="text editable">
<h3>Help other users</h3>
<p>Many users ask questions about Queryverse packages in various
online forums. Answering their questions and helping them
with their problems is an excellent way to contribute
to the Queryverse!
</p>
<p>The main online places where Queryverse users ask questions
are the <a href="https://discourse.julialang.org/c/domain/data">Data category</a> on the general
<a href="https://discourse.julialang.org/">Julia Discourse forum</a> and the data channel
in the Julia <a href="https://julialang.slack.com/"></a>Slack room.
</p>
</div>
</div>
</section>
<section>
<div class="container flex">
<div class="text editable">
<h3>Create Learning Materials</h3>
<p>Writing more documentation, better tutorials, or creating
other learning materials like video tutorials is another
fantastic way to help with the Queryverse.
</p>
<p>For packages that have their documentation in their
README.md file, you can simple open a pull request
with a change to that README file to incorporate
your improvement.
</p>
<p>Packages that have more extensive documentation typically
have a docs folder that contains Markdown files with
the documentation. To make contributions there, simply
open a PR with edits against these Markdown files.
</p>
<p>The content of this webpage is hosted at
<a href="https://github.com/queryverse/queryverse.github.io">https://github.com/queryverse/queryverse.github.io</a>.
If you want to improve this homepage, please open
a pull request in that repository.
</p>
<p>If you created some learning content that is hosted on
its own site, please open a PR against this homepage
with a link to this material, so that other folks
can more easily find it. Such links should go into the
"Learning" section of the site.
</p>
</div>
</div>
</section>
<section>
<div class="container flex">
<div class="text editable">
<h3>Find bugs</h3>
<p>
Every software has bugs, and the Queryverse is no
exception. If you find one, please report it back
to us. Bug reports from the real world are incredibly
valuable. The best way to report a bug is to open
an issue in the github repository for the package
with the bug.
</p>
</div>
</div>
</section>
<section>
<div class="container flex">
<div class="text editable">
<h3>Work on the code of the packages</h3>
<p>
We greatly value help with the actual code of the
packages themselves! The general workflow there is
simple: just open a PR with your improvement on
the relevant package github repository. If you plan
to make larger changes, it is probably a good idea
to first open an issue where we can discuss such
proposals before you start to work on the actual
code.
</p>
</div>
</div>
</section>
</div>