There are many ways in which you can get involved to make this project even better. We really appreciate and welcome contributions and you can help us by:

  • Reporting or fixing issues
  • Improving the documentation
  • Contributing code
  • Covering the code base with more tests

Reporting or Fixing Issues

You can search for existing issues in order to fix them or to raise a new one. We use the GitHub’s issue tracker to keep a track of all our current issues.

Improving the Documentation

The documentation comes in various forms:

  • The Developer Guide built with Asciidoctor
  • The Javadocs documenting the classes of the code base
  • This website

You can find all the materials in our code repositories on Github.

Contributing Code

If you have a great idea and want to contribute it to our code base. You can follow these instructions on your journey to become a GServlet committer.

Fork the project and create a local clone.

Create a pull request

  • write and test your code
  • commit your changes in your local branch
  • push your changes to your remote branch on GitHub
  • send us a pull request

Continuous Integration

As a continuous integration platform, Travis CI supports our development process by automatically building and testing code changes, providing immediate feedback upon success or failure. Whenever a pull request is opened, a build will be triggered.

Continuous Code Quality

To eliminate bugs and vulnerabilities, the sources files are tested with SonarCloud which is a code quality and security service.

Covering the Code

We use Coveralls to track our code coverage over time, and ensure that all our new code is fully covered. You can help us covering the code base with more tests