Skip to content
This repository has been archived by the owner on Oct 2, 2024. It is now read-only.

Latest commit

 

History

History
32 lines (23 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.62 KB
Raw

Contributing

All Contributions to this repository start with a Jira Item associated with the work request.

Pull Request Process

  1. Clone the repository to your local machine.
  2. Build and run the application on your local environment.
  3. Commit your changes to your branch.
  4. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  5. When your change is ready to be reviewed, open a Pull Request on this repository using our Pull Request Template and optionally assign one or more reviewer. Also, in the comment of the Jira item, put a link to the Pull Request and move the item to in review
  6. If some changes are required, you will be notified in the Pull Request, address any change requested and push to the same branch.
  7. When your change meets the requirements of the specified JIRA task, the reviewer will merge the code into master. CELEBRATION!

Open a new bug in jira

A software bug within the CITZ SLAM! API can be defined as an unexpected behaviour, error or functionality that was once present but now is not.

  • When a bug is detected in the application, a jira bug must be opened the bug should be documented as followed:

      - Expected Behavior
  - Current Behavior
  - Steps to Reproduce
  - Environment
  - Description (stack traces, screenshot, error messages, splunk logs query)
  - Optionally you can suggest a possible solution

Open a new feature request in jira

  • For feature enhancements, a jira task or story must be opened