update contributing page

parent 6a31c862
...@@ -5,13 +5,14 @@ title: Contributing ...@@ -5,13 +5,14 @@ title: Contributing
# How can you contribute to the Dynare Project ? # How can you contribute to the Dynare Project ?
As a free, open-source software project, we think of Dynare as a As a [free and open-source
community. Though primary development is undertaken to varying degrees by a software](https://en.wikipedia.org/wiki/Free_and_open-source_software) project,
[core team](/about#team), we encourage others to be involved in any way that we think of Dynare as a community. Though primary development is undertaken to
interests them. That could be anything from attending the [Dynare varying degrees by a [core team](/about#team), we encourage others to be
Conference](#come-to-the-conference), to participating actively in the [Dynare involved in any way that interests them. That could be anything from attending
Forum](#participate-actively-in-the-forum), to spotting and [reporting the [Dynare Conference](#come-to-the-conference), to participating actively in
bugs](#reporting-bugs), to directly making [changes to the the [Dynare Forum](#participate-actively-in-the-forum), to spotting and
[reporting bugs](#reporting-bugs), to directly making [changes to the
codebase](#code-development). [Financial codebase](#code-development). [Financial
contributions](#financial-contributions) also help ensure the continued contributions](#financial-contributions) also help ensure the continued
stability of the Dynare project. stability of the Dynare project.
...@@ -31,26 +32,38 @@ when you're stuck. Along with the manual, it should be a point of reference ...@@ -31,26 +32,38 @@ when you're stuck. Along with the manual, it should be a point of reference
when working with Dynare. when working with Dynare.
As an advanced user, your contribution will be useful in several ways. First As an advanced user, your contribution will be useful in several ways. First
and foremost, you'll be helping others out who are just beginning on the same and foremost, you'll be helping out others who are just beginning on the same
path that you're on. Second, you may be able to bring a perspective to the path that you're already on. Second, you may be able to bring a perspective to
table that's different than that of a beginner and that of someone on the [core the table that's different than that of a beginner and that of someone on the
team](/about#team). Finally, your participation will help foster a larger sense [core team](/about#team). Finally, your participation will help foster a larger
of community and will hopefully allow you gain a deeper understanding of sense of community and will hopefully allow you gain a deeper understanding of
something you already understand well. something you already understand well.
### Reporting Bugs ### Reporting Bugs
If you find a bug in Dynare, please report it on our [Gitlab Issue If you find a bug, we want to know about it! But, first, before you tell us
page](https://git.dynare.org/Dynare/dynare/issues). But! Before you do, please ensure you are working with the latest version of Dynare. about it, make sure it's a real bug. Head over to the [Dynare
Forum](https://forum.dynare.org/) and search for the problem you've
- If reporting a bug in the ***stable*** version of Dynare: encountered; maybe someone else has encountered the same issue and what you
Ensure the bug exists in the [latest stable version of Dynare](/download#stable) telling us exactly how to reproduce the problem. think is a bug is actually intentional behavior. If there's nothing on the
- If reporting a bug in the ***unstable*** version of Dynare: forum and you're not certain it's a bug, please post a question there. We'll
- Ensure the bug exists in the most recent version of the Dynare source code. You can either test it by installing the latest [Dynare snapshot](/download#snapshot) or by installing the source code from the [Git repository](https://git.dynare.org/Dynare/dynare) see it and respond accordingly. If, however, you're sure it's a real bug,
please report it on our Gitlab Issue page. But! Before you do, ensure you are
working with the latest version of Dynare.
- If reporting a bug in the ***stable*** version of Dynare:
<p class="indent" markdown="1">Ensure the bug exists in the [latest stable
version of Dynare](/download#stable) telling us exactly how to reproduce the
problem.</p>
- If reporting a bug in the ***unstable*** version of Dynare:
<p class="indent" markdown="1">Ensure the bug exists in the most recent version
of the Dynare source code. You can either test it by installing the latest
[Dynare snapshot](/download#snapshot) or by compliing the source code from the
[Git repository](https://git.dynare.org/Dynare/dynare).</p>
If you have encountered a bug in the stable version of Dynare, there's a chance If you have encountered a bug in the stable version of Dynare, there's a chance
we have alreday fixed it. You can see alist of bugs fixed on the [fixed bugs we have already fixed it. You can see a list of bugs fixed on the [fixed bugs
Wiki page](https://git.dynare.org/Dynare/dynare/wikis/FixedBugs). There's also Wiki page](https://git.dynare.org/Dynare/dynare/wikis/FixedBugs). There's also
a chance the bug has already been reported. You can see a list of reported bugs a chance the bug has already been reported. You can see a list of reported bugs
by checking both the [known bugs Wiki by checking both the [known bugs Wiki
...@@ -81,8 +94,8 @@ issues by the tags associated with them ...@@ -81,8 +94,8 @@ issues by the tags associated with them
(e.g. [bug](https://git.dynare.org/Dynare/dynare/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=bug), (e.g. [bug](https://git.dynare.org/Dynare/dynare/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=bug),
[enhancement](https://git.dynare.org/Dynare/dynare/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=enhancement), [enhancement](https://git.dynare.org/Dynare/dynare/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=enhancement),
[documentation](https://git.dynare.org/Dynare/dynare/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=documentation), [documentation](https://git.dynare.org/Dynare/dynare/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=documentation),
etc.). Further each issue has an assignee associated with it. If you find an etc.). An individual issue may have an assignee associated with it. If you find
issue you'd like to work on that doesn't have an assignee, feel free to an issue you'd like to work on that doesn't have an assignee, feel free to
manifest your interest in working on it. Further, if it does have an assignee manifest your interest in working on it. Further, if it does have an assignee
but the issue itself is very old, let us know you're interested in working on but the issue itself is very old, let us know you're interested in working on
it too. it too.
...@@ -93,21 +106,25 @@ command: ...@@ -93,21 +106,25 @@ command:
{% highlight text %}git clone https://git.dynare.org/Dynare/dynare.git{% endhighlight %} {% highlight text %}git clone https://git.dynare.org/Dynare/dynare.git{% endhighlight %}
As Dynare is free software licensed under the [GNU General Public License As Dynare is [free
software](https://en.wikipedia.org/wiki/Free_and_open-source_software) licensed
under the [GNU General Public License
(GPL)](https://www.gnu.org/licenses/gpl-3.0.en.html), any enhancements you make (GPL)](https://www.gnu.org/licenses/gpl-3.0.en.html), any enhancements you make
to the Dynare codebase would need to be under GPLv3+ or some other compatible to the Dynare codebase would need to be under GPLv3+ or some other compatible
license (e.g. public domain) so that it could be merged back into Dynare. license (e.g. public domain) so that it could be merged back into Dynare.
## Financial Contributions ## Financial Contributions
Contrary to proprietary software, as a free and open-source software platform, Contrary to proprietary software, as a [free and open-source
we do not recieve funding by licensing the use of Dynare. That means that software](https://en.wikipedia.org/wiki/Free_and_open-source_software)
Dynare will remain a public good that will always be free to download and platform, we do not recieve funding by licensing the use of Dynare. That means
free to modify. that Dynare will remain a public good that will always be free to download,
free to use, and free to modify.
As we don't receive revenue from licensing the use of Dynare, and as our other
potential sources of revenue (summer school) is provided at cost to not set up As we don't receive revenue from licensing the use of Dynare (and as we run the
barriers to participation, we depend on financing from various summer school at cost so as not to set up barriers to participation), we depend
institutions. That financing is often linked to improvements in the Dynare on financing from various institutions. That financing is often linked either
source code itself. If you or your institution would like finance an to improvements in the Dynare source code itself or the maintenance of Dynare
enhancement to Dynare, please get in touch. when used in a production enviornment where responsiveness is of the
essence. If you or your institution would like finance an enhancement to Dynare
or would like to create a maintenance contract, please get in touch.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment