Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 4.17 KB

CONTRIBUTING.md

File metadata and controls

99 lines (71 loc) · 4.17 KB

Contributing to FH-Portfolio-Template

First off, thank you for considering contributing to FH-Portfolio-Template! It's people like you that make FH-Portfolio-Template such a great template.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for FH-Portfolio-Template. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report:

  • Ensure the bug was not already reported by searching on GitHub under Issues.

How Do I Submit A (Good) Bug/Feature Report? Bugs are tracked as GitHub issues. Create an issue and provide the following information (as much as possible):

  • You can use the template attached in the additional notes.
  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
  • You can also use Jam, an extension that allows you to easily capture bugs with additional details like logs and network requests.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.

Additional Notes

Template for Issues

## Issue Type
<!-- Please check one of the following options with an "x" -->
- [ ] Bug Report
- [ ] Feature Request
- [ ] Question / Other

## Description
<!-- Provide a clear and concise description of the issue or feature request -->

## Steps to Reproduce (for bugs)
<!-- Provide a detailed list of steps to reproduce the bug -->
1.
2.
3.
4.

## Expected Behavior
<!-- Describe what you expected to happen -->

## Actual Behavior
<!-- Describe what actually happened -->

## Screenshots
<!-- If applicable, add screenshots to help explain your problem -->

## Environment
<!-- Please complete the following information -->
- OS: [e.g. iOS, Windows, Linux]
- Browser [e.g. chrome, safari] (if applicable)
- Version [e.g. 22]

## Additional Context
<!-- Add any other context about the problem here -->

## Possible Solution
<!-- If you have a suggestion for fixing the bug or implementing the feature, please describe it here -->

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in.

Please open an issue if you have suggestions for new labels.

Type of Issue and Issue State

  • enhancement: Feature requests.
  • bug: Confirmed bugs or reports that are very likely to be bugs.
  • question: Questions more than bug reports or feature requests (e.g. how do I do X).
  • feedback: General feedback more than bug reports or feature requests.
  • help-wanted: The FH-Portfolio-Template core team would appreciate help from the community in resolving these issues.
  • beginner: Less complex issues which would be good first issues to work on for users who want to contribute to FH-Portfolio-Template.
  • more-information-needed: More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).
  • needs-reproduction: Likely bugs, but haven't been reliably reproduced.
  • blocked: Issues blocked on other issues.
  • duplicate: Issues which are duplicates of other issues, i.e. they have been reported before.
  • wontfix: The FH-Portfolio-Template core team has decided not to fix these issues for now, either because they're working as intended or for some other reason.
  • invalid: Issues which aren't valid (e.g. user errors).

Thank you for contributing to FH-Portfolio-Template!