Skip to content

Latest commit

 

History

History
81 lines (46 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

81 lines (46 loc) · 1.48 KB

How to contribute with LaraDumps

Thank you for your interesting in contributing with LaraDumps.

If you have any questions, do not hesitate to reach the community in the repository Discussions tab.

You can fix a bug or even submit a feature. Note that sometimes it will be necessary to send a PR to both repositories

Steps

1 .Fork

git clone https://github.com/laradumps/laradumps.git && cd laradumps

Install all dependencies with composer and NPM.

composer install

Then run:

yarn

  1. Create a new branch

Create a new branch specifying feature, fix, enhancement.

git checkout -b feature/my-new-feature

  1. Code and check your work

Write your code and, when you are done, run the CS Fix:

composer fix

Run tests and static analysis:

composer verify

  1. Tests

Including tests is not mandatory, but if you can write tests, please consider doing it.


  1. Commit

Please send clean and descriptive commits.


  1. Pull Request

Open a Pull Request (PR) detailing your changes and motivations. Please make only one change per Pull Request.

If you never wrote a PR before, see this excellent example by @vs0uz4 for inspiration.


💓 Thank you for contributing!