Skip to content
This repository was archived by the owner on Feb 24, 2023. It is now read-only.

Commit ab44bd6

Browse files
committed
feat(problems): add a section with the rules that must be followed when opening a new issue on GitHub
1 parent f9a8e68 commit ab44bd6

File tree

4 files changed

+18
-5
lines changed

4 files changed

+18
-5
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- [Audit Presentation](audit-presentation.md)
1919
- [Audit Events](audit-events.md)
2020
- Help
21+
- [Problems?](problems.md)
2122
- [Troubleshooting](troubleshooting.md)
2223

2324
## Contributing

documentation.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@
1616
- [Audit Presentation](/docs/{{version}}/audit-presentation)
1717
- [Audit Events](/docs/{{version}}/audit-events)
1818
- Help
19+
- [Problems?](/docs/{{version}}/problems)
1920
- [Troubleshooting](/docs/{{version}}/troubleshooting)

faq.md

-5
This file was deleted.

problems.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Having problems?
2+
3+
If you found or have a problem with this package, let us know!
4+
5+
Bear in mind, however, that nobody likes their time wasted, so before you rush to create a new issue on GitHub, ensure that:
6+
- You have **read** the [installation](installation) and [configuration](general-settings) sections of the documentation;
7+
- The issue you're facing is **not** documented in the [troubleshooting](troubleshooting) section;
8+
- A [GitHub issue](https://github.com/owen-it/laravel-auditing/issues) with the problem you're having doesn't already exist (in an open or closed state);
9+
10+
If all of the above applies, feel free to [open a new issue](https://github.com/owen-it/laravel-auditing/issues/new).
11+
12+
Also be aware that filling the [issue template](https://github.com/owen-it/laravel-auditing/blob/master/.github/ISSUE_TEMPLATE.md) is **mandatory** when opening a new issue.
13+
14+
Failure to do so, will result in a closed ticket.
15+
16+
Abide by these simple terms, and we're all good :-)

0 commit comments

Comments
 (0)