Skip to content

Latest commit

 

History

History
95 lines (55 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

95 lines (55 loc) · 1.81 KB

PowerGrid Logo

How to contribute with ⚡ PowerGrid ⚡

Thank you for your interesting in contributing with PowerGrid.

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

Steps

1 .Fork

git clone https://github.com/Power-Components/livewire-powergrid.git && livewire-powergrid

Install all dependencies with composer and NPM.

composer install

Then run:

npm install

  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 check

  1. Build Assets

If you have updated or added JavaScript code, you need to recompile the assets and include it in your commit.

npm run build

  1. Tests

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

Besides all technical benefits, tests also help to prove your concept and make the maintainers' job easier. PowerGrid is developed entirely by volunteers.


  1. Commit

Please send clean and descriptive commits.


  1. Pull Request

Open a Pull Request (PR) and use the template for 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!