Skip to content

Commit f61a82e

Browse files
committed
add simple contributing guide
1 parent fdb4c72 commit f61a82e

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
To start contributing you need to have a basic understanding of the following:
4+
5+
* [PHP](https://php.net) & [Laravel](https://laravel.com)
6+
* [Livewire](https://laravel-livewire.com) & [Filament](https://filamentphp.com)
7+
* [Git](https://git-scm.com) & [Github](https://github.com)
8+
9+
You can find detailed information on how plugins work in [our documentation](https://pelican.dev/docs/panel/advanced/plugins#create-a-plugin).
10+
11+
For information on setting up a panel dev environment, see the [contributing guide in the panel repo](https://github.com/pelican-dev/panel/blob/main/contributing.md#dev-environment-setup).
12+
13+
## Coding Standards
14+
15+
We use PHPStan/[Larastan](https://github.com/larastan/larastan) and PHP-CS-Fixer/[Pint](https://laravel.com/docs/12.x/pint) to enforce certain code styles and standards.
16+
You can run PHPStan via `\vendor\bin\phpstan analyse plugins` and Pint via `\vendor\bin\pint`.
17+
18+
## Making Contributions
19+
20+
From your forked repository, make your own changes on your own branch. (do not make changes directly to `main`!)
21+
When you are ready, you can submit a pull request to the Pelican repository. If you still work on your pull request or need help with something make sure to mark it as Draft.
22+
23+
If you add a new plugin, make sure to update the main README.
24+
25+
Also, please make sure that your pull requests are as targeted and simple as possible and don't do a hundred things at a time. If you want to add/change/fix 5 different things you should make 5 different pull requests.
26+
27+
## Community and Support
28+
29+
* Help: [Discord](https://discord.gg/pelican-panel)
30+
* Bugs & Features: [GitHub Issues](https://github.com/pelican-dev/plugins/issues)

0 commit comments

Comments
 (0)