Skip to content

Commit 9830e9b

Browse files
committed
add details on open issues
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
1 parent 46e5d2a commit 9830e9b

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,38 @@ https://www.eclipse.org/projects/handbook/#resources-commit
4343
Contact the project developers via the project's "dev" list.
4444

4545
* https://dev.eclipse.org/mailman/listinfo/jnosql-dev
46+
47+
48+
== Issues
49+
50+
If you found a bug or have an idea, check out the following sections before submitting your contribution.
51+
52+
=== Check the issue tracker
53+
54+
All our issues are centralized in our https://github.com/eclipse/jnosql[**main repository**], it is quite likely that you will find a topic that is being discussed. Check the https://github.com/eclipse/jnosql/issues[**open issues**], another good way to start is https://github.com/eclipse/jnosql/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22[**good first issues**].
55+
56+
=== Open an issue for any new problem
57+
58+
Writing a good issue will help our team better analyze and manage your contributions, therefore, follow the standards and best practices below:
59+
60+
**With the title:**
61+
62+
**Project:Scope - Title Description**
63+
64+
- **Project:** Name of the project or repository you want to contribute to.
65+
66+
- **Scope:** Add what your issue refers to:
67+
68+
- **https://github.com/eclipse/jnosql/issues/new?assignees=&labels=bug&template=bug_report.md&title=[Bug report]:** Report a reproducible bug.
69+
70+
- **https://github.com/eclipse/jnosql/issues/new?assignees=&labels=&template=feature_request.md&title=[Feature request]:** Suggest a new idea for Eclipse JNoSQL.
71+
72+
> **Example: Eclipse JNoSQL:feat request - Suggestion for a better user experience**
73+
74+
**With the issue description:**
75+
76+
Try to explain the scenario to us by following these tips:
77+
78+
- **Context:** explain the conditions which led you to write this issue.
79+
- **Problem or idea:** the context should lead to something, an idea or a problem that you’re facing.
80+
- **Solution or next step:** this where you move forward. You can engage others (request feedback), assign somebody else to the issue, or simply leave it for further investigation, but you absolutely need to propose a next step towards solving the issue.

0 commit comments

Comments
 (0)