guidelines v1

.github/ISSUE_TEMPLATE/issue_report.md

@@ -0,0 +1,38 @@
+---
+name: Issue Report
+about: Report an issue to help us improve
+title: '[ISSUE] '
+---
+
+**Article and Module Links**
+A link to the affected article and the affected module. The link to the module is the one in the "over on GitHub" standard phrase.
+
+**Describe the Issue**
+A clear and concise description of what the issue is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected Behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+- OS: [e.g. Windows]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Additional Context**
+Add any other context about the issue here.
+
+Note that, unfortunately, we can only help with issues that are specifically and directly related to the article - not with your own, custom application.
+
+StackOverflow is a great place to ask more general questions.
+
+That's primarily because we get a large number of questions and - while we do try to go through as much as everything and help wherever we can, we can't really get back to all of them.

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing to Baeldung Tutorials
+First off, thank you for considering contributing to Baeldung Tutorials.
+
+## Reporting Issues
+Before you submit an issue, please review the guidelines below:
+
+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.
+2. **Use a clear and descriptive title** for the issue to identify the problem.
+3. **Include a link to the article** you're having issues with.
+4. **Describe the exact steps which reproduce the problem** in as many details as possible.
+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.