Skip to content

Commit 43be825

Browse files
committed
Add contribution guidelines for the sql-tutorials
1 parent 1174db6 commit 43be825

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

Diff for: .github/ISSUE_TEMPLATE/issue_report.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Issue Report
3+
about: Report an issue to help us improve
4+
title: '[ISSUE] '
5+
---
6+
7+
**Article and Module Links**
8+
A link to the affected article and the affected module. You can find the link to the module in the Conclusion section in the "on Github" standard phase.
9+
10+
**Describe the Issue**
11+
A clear and concise description of what the issue is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected Behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment (please complete the following information):**
27+
- OS: [e.g. Windows]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Additional Context**
32+
Add any other context about the issue here.

Diff for: CONTRIBUTING.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Contributing to Baeldung Tutorials
2+
First off, thank you for considering contributing to Baeldung Tutorials.
3+
4+
## Reporting Issues
5+
Before you submit an issue, please review the guidelines below:
6+
7+
1. **No Custom Modifications:** If your issue arises from any custom modifications you've made to the code in the repository, we won't be able to assist. We can only help if the issue is reproducible with the untouched codebase from this repo. If you're working with a modified version, consider asking for help on StackOverflow or other relevant forums.
8+
2. **Use a clear and descriptive title** for the issue to identify the problem.
9+
3. **Include a link to the article** you're having issues with.
10+
4. **Describe the exact steps which reproduce the problem** in as many details as possible.
11+
5. **Additional Details:** Offer any other context or descriptions that could be useful. Screenshots, error messages, copy/pasteable snippets, or logs can be immensely helpful.

0 commit comments

Comments
 (0)