Skip to content
This repository has been archived by the owner on Dec 7, 2024. It is now read-only.

Latest commit

 

History

History
34 lines (24 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 2.42 KB
Raw

Reporting Bugs

Use the GitHub issue tracker for bugs and feature requests. Please do NOT post usage or installation questions there, it is not a forum!

Guidelines:

  • Create one issue per bug or feature request
  • Do not mix multiple bugs or feature requests into a single issue
  • Search the issue tracker if the issue has already been reported
  • Ensure you are running the latest version of PartKeepr
  • Try to reproduce the problem on demo.partkeepr.org prior reporting the issue and indicate in the issue that you have done so
  • Report your browser type and version, any JavaScript errors in the console and any other details like server operating system, php version, SQL Server type and version etc.
  • Check your logs, especially your Web Server Log as well as app/logs/partkeepr.log
  • Only attach the parts of the logs which are relevant to the problem.
  • Make sure the problem is reproducable. If it only happened one time, you have to find out on how to reproduce it.
  • Explain, in simple words, when the issue occured. For example: Don't write "I can't create a part". Rather write: "I clicked on Add Part, entered a Part Name, then I clicked the save button, then nothing happens. There were no JavaScript errors in the console, and no HTTP Request was sent."
  • Try to limit your bug report to only essential steps on how to reproduce the issue.
  • In short, help the volunteers maintaining the project to spend as little effort as possible on the issue, so that we can have more time adding features and fixing bugs more easily.

For further reading have a look at https://www.softwaretestinghelp.com/how-to-write-good-bug-report/ on how to write good bug reports.

Use the dedicated mailing list or IRC for general questions as described on the PartKeepr Support Page.

Contributing Code

Create a pull request on GitHub to contribute new features and bugfixes.

Guidelines: