Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 2.82 KB
Raw

Contributing to Security-C4PO

First off, thanks for taking the time to contribute! 👍

The following is a set of guidelines for contributing to this project and its packages, which are hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started the application, e.g. which command exactly you used in the terminal, or how you started the application otherwise. When listing steps, don't just say what you did, but explain how you did it.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Include screenshots, mock-ups or animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to.
  • Explain why this enhancement would be useful

Code of Conduct

Use the following conventions:

  • Branch: <initial>_c4po_<issuenumber>
  • Commit: feat: <What was implemented?> or fix: <What got fixed?> By participating, you are expected to uphold this code.

Local development

Security-C4PO and all it's included micorservices can be developed locally. Execute c4po-dev.sh and all services will run on a dev server.

Testuser Credentials:

  • Username: c4po
  • Password: Test1234!

Technical Environment Requirements

  • Docker / Docker-compose
  • OpenJDK 11
  • Node 14.15.1 / npm 6.14.8

Helpfull Tools

  • mongoDB Compass
  • Postman

Issue Board

C4PO Board