Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 1.84 KB

How to contribute to PIRS

P.I.R.S. is a cloud-first business process register. It can be deployed for internal use or for public access. PIRS consists of several microservices to manage register of business processes. PIRS deployments can be connected together to make large network of accessible business processes.

Ways you can contribute

First, make sure you've read the code of conduct. TL;DR: be excellent to each other. Be calm, be kind, help make engine a community where new faces feel welcome and old hands feel appreciated.

  • Report a bug. If you've found something that does not work or does not make sense, let us know.
  • Suggest a new feature.
  • Suggest improvements to the platform.

Reporting bugs

If you've found a bug, let us know about it.

  • Search the Issues to check we're not already tracking it.
  • If you can't find an open issue that describes your problem, open a new one.
    • Include a title and clear description
    • Describe:
      • What you did (ideally with a code sample or executed steps)
      • What you expected to happen
      • What actually happened, including any error messages or program output.
      • Include the version of the platform and environment that you used to run the program.

Contributing Features

If you've got a great idea for a feature, start by checking issues to check we're not already tracking it, or that your idea hasn't already been rejected.

If not, start by opening an issue that describes your idea. Do not be afraid of rejection, every excellent idea has to start somewhere. Give it a well described solution to the problem which your proposition is trying to solve.