Skip to content

Commit db5f71c

Browse files
committed
add CONTRIBUTING.md and SECURITY.md
[skip ci]
1 parent ae317a2 commit db5f71c

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# How to contribute to LearnLib
2+
3+
4+
### **Did you find a bug?**
5+
6+
* **If the bug is a security vulnerability** do not open up a GitHub issue but instead refer to our [security policy](https://github.com/LearnLib/learnlib/blob/develop/SECURITY.md).
7+
8+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/LearnLib/learnlib/issues).
9+
10+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/LearnLib/learnlib/issues/new?template=bug_report.md). Please provide as much relevant information as possible including a precise title.
11+
12+
13+
### **Did you write a patch that fixes a bug?**
14+
15+
* Open a new GitHub pull request with the patch.
16+
17+
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
18+
19+
* Before submitting, you can test locally whether the integration tests will (likely) pass. Simply enable the same Maven profiles as our [CI pipelines](https://github.com/LearnLib/learnlib/blob/develop/.github/workflows/ci.yml).
20+
21+
22+
### **Do you intend to add a new feature or change an existing one?**
23+
24+
* Suggest your change in the [discussions](https://github.com/LearnLib/learnlib/discussions/categories/ideas) and start writing code.
25+
26+
* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and confirmed feature requests.
27+
28+
29+
### **Do you have questions about the source code?**
30+
31+
* Ask any questions about how to use LearnLib in the [discussions](https://github.com/LearnLib/learnlib/discussions/categories/q-a).

SECURITY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Reporting Security Issues
2+
3+
To report a security issue, please use the GitHub ["Security Advisory"](https://github.com/learnlib/learnlib/security/advisories/new) function.
4+
5+
The LearnLib team will send a response indicating the next steps in handling your report. After the initial reply to your report, we will keep you informed of the progress towards a fix and may ask for additional information or guidance.

0 commit comments

Comments
 (0)