diff options
| author | 1138-4EB <1138-4EB@users.noreply.github.com> | 2017-12-14 09:05:01 +0100 |
|---|---|---|
| committer | tgingold <tgingold@users.noreply.github.com> | 2017-12-15 06:13:28 +0100 |
| commit | e89bb574675e6225110a654f712b8ea916609cc2 (patch) | |
| tree | db954a09e6e64492b05e36df1115fc58c88d8133 /doc/contribute.rst | |
| parent | a0ea3c04c7fdb1795ee8c5bd235cb838bb68af98 (diff) | |
| download | ghdl-e89bb574675e6225110a654f712b8ea916609cc2.tar.gz ghdl-e89bb574675e6225110a654f712b8ea916609cc2.tar.bz2 ghdl-e89bb574675e6225110a654f712b8ea916609cc2.zip | |
fix doc/building
Diffstat (limited to 'doc/contribute.rst')
| -rw-r--r-- | doc/contribute.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/contribute.rst b/doc/contribute.rst index 3313c85a8..d79d1bf52 100644 --- a/doc/contribute.rst +++ b/doc/contribute.rst @@ -14,8 +14,7 @@ If you are more familiar with GHDL, you might start asking yourself how it works While using GHDL, you might find flaws, such as bugs, missing features, typos in the documentation or topics which are still not covered. In order to improve GHDL, we welcome bug reports, suggestions and contributions for any aspect of GHDL. Either if it's a bug or an enhancement, have a look at the |SHIELD:issues-open| and |SHIELD:issues-closed| to see -if someone already told us about it. You might find a solution there. To get a broader view, you can also check the -:ref:`Roadmap <CHANGE>`. +if someone already told us about it. You might find a solution there. If you found no information on your topic, please, report so that we are aware! You can reach us through various ways: |SHIELD:gitter| or open a |SHIELD:issues-new|. @@ -100,8 +99,9 @@ write access to our repositories, the project is hosted at GitHub, which follows 5. Last, the maintainers will merge your branch. You will be notified, the PR will be closed, and you'll be allowed to delete the branch, if you want. .. TIP:: - * It is recommended to read `A successful Git branching model <http://nvie.com/posts/a-successful-git-branching-model/>`_ for a reference on how maintainers expect to handle multiple branches. However, our actual model is not as exhaustive as explained there. - * Some commit messages can `automatically close <https://help.github.com/articles/closing-issues-via-commit-messages/>`_ issues. This is a very useful feature, which you are not required to use. However beware that using `fix` anywhere in the commit message can have side effects. If you closed any issue unexpectedly, just reply to it (even if it's closed) so that maintainers can check it. + * It is recommended to read `A successful Git branching model <http://nvie.com/posts/a-successful-git-branching-model/>`_ for a reference on how maintainers expect to handle multiple branches. However, our actual model is not as exhaustive as explained there. + * Some commit messages can `automatically close <https://help.github.com/articles/closing-issues-via-commit-messages/>`_ issues. This is a very useful feature, which you are not required to use. However beware that using `fix` anywhere in the commit message can have side effects. If you closed any issue unexpectedly, just reply to it (even if it's closed) so that maintainers can check it. + * It is recommended to read :ref:`REF:Style` before contributing modifications to Ada sources. Related interesting projects ============================ |