Contribute
Serverpod is built by the community for the community. Pull requests are very much welcome. If you are making something more significant than just a tiny bug fix, please get in touch with Serverpod's lead developer Viktor Lidholt before you get started. This makes sure that your contribution aligns with Serverpod's overall vision and roadmap and that multiple persons don't do the same work.
Working on Serverpod
The main Serverpod repository contains all Serverpod code and code for tests and official modules and integrations. Send any pull requests to the dev
branch.
Writing code
We are very conscious about keeping the Serverpod code base clean. When you write your code, make sure to use dart format
and that you don't get any errors or lints from dart analyze
.
Testing
Continuous integration tests are automatically run when sending a pull request to the dev
branch. You can run the tests locally by changing your working directory into the root serverpod directory and running:
util/run_tests
We are currently refactoring the testing infrastructure to make it easier to run individual tests. We will update this documentation page as soon as that work is complete.
Tests may not yet work if running on a Windows machine.
Getting support
Feel free to post on Serverpod's discussion board if you have any questions. We check the board daily.