Skip to content

Latest commit

 

History

History
159 lines (94 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

159 lines (94 loc) · 4.35 KB
Raw

PowerGrid Logo

PowerGrid Contribution Guide

💓 Thank you for your interest in contributing to PowerGrid.

Contributions are welcome and appreciated. There are many different ways to contribute to this project.

Contribution areas

Here are some ways you can contribute and make an impact on PowerGrid.

Community building

PowerGrid relies on a community of users and contributors. You can help build a stronger community by:

  • Participating in the Discussions tab.
  • Write an article, tutorial, or record a YouTube video using PowerGrid.
  • Creating social media posts with PowerGrid content. You can talk about features, updates, and releases.
  • Sharing your code skills by helping newcomers and mentoring other users.

Design

We try to grow the PowerGrid brand in a professional and impactful way.

We appreciate your help with:

  • Creating artwork and improving the package's branding and presentation material.
  • Creating promotional and marketing materials for social media, video, and web content.
  • Providing or improving table components style.

Translation

  • PowerGrid is used by people in different parts of the world. You can help with translation (localization) and help the project better adapt to your community.

Documentation

To be successful, an open-source project must have high-quality documentation.

We appreciate your help with:

  • Try, review, and suggest changes to improve the user’s experience with any PowerGrid documentation content.
  • Maintain the README and CONTRIBUTING guides.
  • Adding, improving, or correcting the documentation directly in the Power-Components/powergrid-doc repository.

Demo Code

Issues and Support

You can help the PowerGrid Team and contributors with handling open Issues and support requests.

  • Test, reproduce, and validate reported bugs.
  • Answer user questions in the Issues and Discussions tabs.

Code Contribution

To build and test the code, follow the steps described in this section.

1 .Fork

git clone https://github.com/Power-Components/livewire-powergrid.git && cd 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 verify

  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 to detail your changes and motivations. Please make only one change per Pull Request.

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


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

Thank you,

⚡ The PowerGrid Team and Contributors