Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.89 KB

Contributing to LUNA-SAMPLES

First, thanks for considering contributing to this project! There are several ways you can contribute:

  • Add New Samples : You can contribute by adding new samples for a specific topic that isn't already included in this project.
  • Report Bugs or Suggest Improvements : You can report bugs, point out mistakes in a code or suggest improvements within that code.
  • Fix Typos or Grammatical Errors : Typos or grammatical errors are easy to overlook! If you spot any, please feel free to notify us via an issue.
  • Improve Documentation : If anything in the documentation is missing or unclear, feel free to open a Discussion/Issue for that.

How to Contribute

  1. Fork : Create a personal fork of the repository by clicking on the "Fork" button.

  2. Clone your fork to your local machine

  3. Make your changes : Add your new sample code, fix a bug, correct or improve documentation.

  4. Commit and push changes to your forked repository.

  5. Open a Pull Request : Go to luna-samples repository and open a pull request. Ensure your Pull Request includes the following:

    • A clear title and description about your contribution.
    • Point out what you added or changed within your fork.
    • Describe how you tested your code.
    • Add additional information such as programming language, OS, Luna HSM model, firmware version etc.

Code of Conduct

By contributing, you agree to follow our Code of Conduct. The guidelines are as follows -

  • Ensure your code is well commented but avoid excessive commenting.
  • Follow the existing code style or use the code template provided within each samples directory.
  • Do not hardcode login credentials or other sensitive data.
  • Review your code using SAST (Static Application Security Testing) / DAST (Dynamic Application Security Testing) tools.
  • If you're unsure about anything, feel free to open an issue or ask for help.