diff options
author | Patrick Lehmann <Paebbels@gmail.com> | 2018-05-26 22:27:10 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-05-26 22:27:10 +0200 |
commit | b350596efe2ff4da88b25de862d5ed4931386a46 (patch) | |
tree | cada732fa6767cd7ad91da17d81380d8ed670def /doc | |
parent | 411cca2e3afd590f4e0c50fec08165de5a11b807 (diff) | |
parent | 7a005d5e7652517d5818e201d2d81c597ac75189 (diff) | |
download | ghdl-b350596efe2ff4da88b25de862d5ed4931386a46.tar.gz ghdl-b350596efe2ff4da88b25de862d5ed4931386a46.tar.bz2 ghdl-b350596efe2ff4da88b25de862d5ed4931386a46.zip |
Merge pull request #583 from 1138-4EB/add-issue-templates
add .github (issue templates)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/contribute.rst | 6 | ||||
-rw-r--r-- | doc/shields.inc | 12 |
2 files changed, 15 insertions, 3 deletions
diff --git a/doc/contribute.rst b/doc/contribute.rst index 67541da11..cf1ca7c2a 100644 --- a/doc/contribute.rst +++ b/doc/contribute.rst @@ -36,7 +36,7 @@ Reporting bugs * If the executable created from your VHDL sources crashes, this may be a bug at runtime or the code itself may be wrong. However, since VHDL has a notion of pointers, an erroneous VHDL program (using invalid pointers for example) may crash. * If a compiler message is not clear enough, please tell us. The error messages can be improved, but we have not enough experience with them. -Please, report issues of this kind through |SHIELD:issues-new|, as this allows us to categorize issues into groups and +Please, report issues of this kind through |SHIELD:bug-report|, as this allows us to categorize issues into groups and assign developers to them. You can track the issue’s state and see how it’s getting solved. .. IMPORTANT:: @@ -65,7 +65,7 @@ assign developers to them. You can track the issue’s state and see how it’s Requesting enhancements ======================= -|SHIELD:issues-new| |SHIELD:gitter| +|SHIELD:feature-request| |SHIELD:gitter| All enhancements and feature requests are welcome. Please `open a new issue <https://github.com/ghdl/ghdl/issues/new>`_ to report any, so you can track the request's status and implementation. Depending on the complexity of the request, you may want to `chat on Gitter <https://gitter.im/ghdl/ghdl1>`_, to polish it before opening an issue. @@ -85,7 +85,7 @@ Fork, modify and pull-request ============================= .. TIP:: - * Before starting any modification, you might want to have a look at |SHIELD:issues-pr| and |SHIELD:issues-pr-closed|, to check which other contributions are being made or have been made. If you observe that the modifications you are about to start might conflict with any other, please |SHIELD:gitter| or open a |SHIELD:issues-new| to coordinate. + * Before starting any modification, you might want to have a look at |SHIELD:issues-pr| and |SHIELD:issues-pr-closed|, to check which other contributions are being made or have been made. If you observe that the modifications you are about to start might conflict with any other, please |SHIELD:gitter| or open a |SHIELD:new-pr| to coordinate. * See section :ref:`BUILD:dir_structure` to faster find the location of the sources you need to modify, and/or to know where to place new ones. Contributing source code/documentation via `Git <https://git-scm.com/>`_ is very easy. Although we don't provide direct diff --git a/doc/shields.inc b/doc/shields.inc index 562551ede..ed8f91afd 100644 --- a/doc/shields.inc +++ b/doc/shields.inc @@ -37,6 +37,18 @@ :target: https://github.com/ghdl/ghdl/issues/new :alt: Open new issue at GitHub +.. |SHIELD:new-pr| image:: https://img.shields.io/badge/new-pull--request-yellowgreen.svg?style=flat + :target: https://github.com/ghdl/ghdl/compare/ + :alt: Open new Pull Request (PR) at GitHub + +.. |SHIELD:bug-report| image:: https://img.shields.io/badge/new-bug--report-yellowgreen.svg?style=flat + :target: https://github.com/ghdl/ghdl/issues/new?template=bug_report.md + :alt: Open new bug report at GitHub + +.. |SHIELD:feature-request| image:: https://img.shields.io/badge/new-feature--request-yellowgreen.svg?style=flat + :target: https://github.com/ghdl/ghdl/issues/new?template=feature_request.md + :alt: Open new feature request at GitHub + .. |SHIELD:issues-open| image:: https://img.shields.io/github/issues/ghdl/ghdl.svg :target: https://github.com/ghdl/ghdl/issues :alt: Open issues |