Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 1.73 KB
Raw

CONTRIBUTING

New Features or bug fixes

We love pull requests from everyone. By participating in this project, you agree to abide by our code of conduct.

Fork, then clone the repo:

git clone git@github.com:your-username/filament-url-mapper.git

Install the composer packages:

composer install

Make sure the tests pass:

vendor/bin/pest

Make your change. Add tests for your change.

Push to your fork and submit a pull request.

At this point you're waiting on us. We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

  • Write tests.
  • Follow our style guide.
  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are up-to-date.
  • Write a good commit message.

Submitting an issue

Some things to consider before submitting an issue

  • Search the existing issues to see if it already has been asked or reported.
  • If you do find a similar issue, upvote it by adding a 👍 reaction . If you have relevant information to add, do so in a comment. Please don't add a +1 comment.
  • When making an issue, follow the issue templates and provide as much information as possible, even better try to provide a repository demonstrating the issue.

Coding style

See our guidelines.

Laravel Pint

Don't worry if your code styling is not perfect! Each of our packages have a Laravel Pint Github Action will automatically merge any style fixes into the package when you commit changes to a pull request.