Contributing to Pip.Services

Pip.Services is a big project that includes a large amount of components, templates, examples, and documentation. This project could never have become a reality without the help of our active community.

We are always open to new ideas and provide everyone with the opportunity to take part in the project and contribute to it. If you decide to step it up a notch and feel ready to become a part of our team - send us a message! Tell us of your experience and how you would like to participate. One of our team members will be sure to contact you within the next 48 hours.

There are multiple ways to help the project:

Report a problem

Before sending an error report, please check to make sure that the error hasn’t already been reported, fixed in a newer version, or fixed in the version we are currently working on. If you don’t find anything on the problem you’ve discovered, go ahead and create a GitHub report in the corresponding repository.

If you know how to fix the problem, please include this information in your report. To help our team fix the problem as quickly as possible, include as much information in your report as you can, like: the platform you’re using, the versions of any applications/packages/modules you’re using, error logs, configurations, etc. If you’re not sure how much of the information is relevant, feel free to include everything you’ve got.

Improve documentation

As Pip.Services constantly evolves, so do the components that it’s made up of. Over time, this can lead to out-of-date documentation. If you have thoughts on how to improve or fix our documentation, don’t hesitate to share your ideas with us! You can also contribute by writing-up new documentation, tutorials, and recipes on using the Pip.Services Toolkit.

Answer questions

If you’re an experienced user of the Pip.Services Toolkit and you feel that you are ready to give us a hand in answering the questions we get from other developers - we’d greatly appreciate your help on the forum, or by answering their questions by email.

Expand an existing component or write a new one

If you’ve developed a new component using the Pip.Services Toolkit or expanded one that already exists and would like to share your work - write us, and we’ll help you publish your achievements.

You can also help out in developing new microservices and templates for them, even in programming languages that are not supported by the Pip.Services Toolkit yet.

When writing your code, please use our recommendations on formatting code and documentation.

Our appreciation

As a sign of our appreciation, the most active contributors will be added to our team’s page and receive a small prize.