summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorPierre Joye <pierre.php@gmail.com>2021-09-04 18:28:54 +0700
committerPierre Joye <pierre.php@gmail.com>2021-09-04 18:28:54 +0700
commitae7c6b263a795ba3ceb39a698248f2a0354c29d3 (patch)
treea7e439243f6cf5c8e441506c5a2142992c6688ad /CONTRIBUTING.md
parentef7de619a37087a86253e2e89fcb54f4cd2807e7 (diff)
downloadlibgd-ae7c6b263a795ba3ceb39a698248f2a0354c29d3.tar.gz
small additions and remove old things
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md28
1 files changed, 20 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3382a33..84da37f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -9,9 +9,8 @@
* [Repositories](#Repositories)
[How Can I Contribute?](#how-can-i-contribute)
- * [Reporting Bugs](#reporting-bugs)
- * [Suggesting Enhancements](#suggesting-enhancements)
- * [Your First Code Contribution](#your-first-code-contribution)
+ * [Documentations and examples](#documentation-and-examples)
+ * [Reporting Bugs or suggest enhancements](#reporting-bugs-or-request-a-feature)
* [Pull Requests](#pull-requests)
[Styleguides](#styleguides)
@@ -36,18 +35,31 @@ Please report unacceptable behavior to [security@libg.org](mailto:security@libgd
## How Can I Contribute?
-### Reporting Bugs
+### Documentation and examples
-This section guides you through submitting a bug report for Atom. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
+We have a relatively complete API documentation. However good documentation requires more than API docs. If you feel like writing tutorials, examples (C or other language binding) or add content to the documentation, you will be more than welcome.
+
+We use NaturalDocs 1.5x for the API and general documentations. It supports rest, markdown or text (see the docs folder in our repository for examples).
+
+### Reporting Bugs or request a feature
+
+This section guides you through submitting a bug or feature report for LibGD. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). If you'd like, you can use [this template](#template-for-submitting-bug-reports) to structure the information.
-#### Before Submitting A Bug Report
-* **Determine [which repository the problem should be reported in](#atom-and-packages)**.
+### Before Submitting A Bug Report
+
* **Perform a [cursory search](https://github.com/issues?q=+is%3Aissue+user%3Alibgd)** to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.
-#### How Do I Submit A (Good) Bug Report?
+
+### Before Submitting A feature Request
+
+Please take the time to clearly describe what this feature should achieve. A good specification will help us to implement it, if it fits the roadmap.
+
+We also have some open features, please check if the feature you would like to have is not already there. Maybe the specification can boost its implementation?
+
+### How Do I Submit A (Good) Bug Report?
For security related bugs, github does not support private issues, that's why we have to handle security issues outside the issues tracker for now. Please drop a mail to [security@libg.org](mailto:security@libgd.org).