Skip to content

Commit

Permalink
Update contribution docs (EN) (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
linc authored Sep 2, 2024
1 parent 5daf927 commit 6244734
Showing 1 changed file with 26 additions and 24 deletions.
50 changes: 26 additions & 24 deletions docs/en/contribute.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,34 @@
> You'd like to contribute to agorakit? Thank you !
You'd like to contribute to Agorakit? Thank you!
There are many ways to contribute.
Whether you have an hour a day or an hour a month, help is really appreciated!

## You are a communication & support person ?
## Communication
- Talk about the project to people who might need it
- Install it for non technical users/friends/groups
- Help on the translations / add new translations
- Write end users documentation
- Enhance the presentation website with pictures and better texts. It's all there waiting for your pull requests : https://github.com/agorakit/agorakit-website
- Support existing users on the Agorakit shared server at https://app.agorakit.org
- Send me an email if you use the tool or are considering it. I love feedback! (info (at) agorakit.org)
- Add or improve translations
- Write end-users documentation

> There are tons of way to contribute, everything is highly appreciated.
## Technical Support
- Install it for non-technical folks
- Improve the [website](https://github.com/agorakit/agorakit-website)
- Support existing users on the [Agorakit shared server](https://app.agorakit.org)
- Support folks with technical [issues](https://github.com/agorakit/agorakit/issues) to help define bugs.
- Send an email if you use the tool or are considering it. We love feedback! (info (at) agorakit.org)

## You are a developer proficient with laravel/php/html/css/js ?
- You are a backend developer with experience of the Laravel framework: add new features, fix bug, write tests, document everything. I happily accept pull requests if they pass unit tests and follow the project philosophy
- You are a frontend developer with experience of the Laravel framework: the current UI is not pretty, make it brilliant. Fix UX as you see fit. I happily accept pull requests if they pass unit tests and follow the project philosophy. We don't want the project to become a one page app powered by the latest "à la mode" js framework.
- If you have some time to give to this project, there are already some issues to fix (see. https://github.com/agorakit/agorakit/issues). Whether you have one hour per day or one hour per month, help is really appreciated! And remember, "talk is silver, code is gold" :-)
- Let's talk in the issue queue if your idea involves big changes.
## Developers
- Check out [open issues](https://github.com/agorakit/agorakit/issues) and [projects to initiate](https://github.com/agorakit/agorakit/blob/main/ROADMAP.md). We use [trunk-based development](https://trunkbaseddevelopment.com/).
- Backend developers with Laravel experience: add new features, fix bug, write tests, document everything. I happily accept pull requests if they pass unit tests and follow the project philosophy.
- Frontend developers with Laravel experience: Help make the UI brilliant. Fix UX as you see fit. I happily accept pull requests if they pass unit tests and follow the project philosophy. We don't want the project to become a one-page app powered by the latest "à la mode" Javascript framework.
- Let's talk in the issue queue first if your idea involves big changes. Create a new issue if you want to discuss something in the roadmap.
- Want to propose a change to the [roadmap](https://github.com/agorakit/agorakit/blob/main/ROADMAP.md)? Create a pull request to solicit comments.

Make a branch of the master branch, work on your branch and create a pull request when ready. See http://scottchacon.com/2011/08/31/github-flow.html

## Financial support
- Consider donating to help me work on it (check https://agorakit.org)
- Help me find ways to support financially the project (sponsorship, public subsidies, etc.)
- Financial support is btw the key to offer a free hosted version in the future for those groups that can't afford to pay.
## Sponsorship
- Consider [donating](https://agorakit.org/en/support.php) to help me work on it.
- Help me find ways to financially support the project (sponsorship, public subsidies, etc.)
- Financial support is critical to offering a free hosted version for groups that can't afford to pay.

## Licence
All the work is open source (AGPL)
- Your work will benefit every interested citizen initiative. We already have 1000's of users who might benefit from your help. The work is made under the AGPL licence.
- It also means that if you use this codebase, you must contribute back your changes.
All work is open source under the AGPLv3.
That means _anyone_ who improves the project must make the changes open source as well.
We already have thousands of users who might benefit from your help.

Please drop a line to info (at) agorakit.org if you are interested or have any question.
Please drop a line to info (at) agorakit.org if you are interested or have any question.

0 comments on commit 6244734

Please sign in to comment.