👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Laravel Crud Tools.
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to przyczynski@gmail.com.
This section guides you through submitting a bug report for Laravel Crud Tools. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Check the readme. Always check the version that you're using and test first if it's happening on the latest one.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- 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.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a newer version) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of the package? What's the most recent version in which the issue doesn't happen?
Include details about your configuration and environment:
- Which version are you using? You can get the exact version by checking the composer.json file on our project.
- What's the version of PHP you're using?
- What's the name and version of the Database Engine (DBMS) you're using?
- Are you running your project in a docker container or directly on your local machine?
This section guides you through submitting an enhancement suggestion for Laravel Crud Tools, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.
The process described here has several goals:
- Maintain package quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Laravel Crud Tools package
- Enable a sustainable system for maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Fork the repository
- Create a branch with the specific feature, bug or refactor needed
- Check if Github Actions are working and the tests are passing on Your PR
- Create a PR for the develop branch on this repository
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.