Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution Documentation #236

Open
emmanuelgautier opened this issue Dec 15, 2024 · 0 comments
Open

Contribution Documentation #236

emmanuelgautier opened this issue Dec 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@emmanuelgautier
Copy link
Member

This issue serves as a discussion place. The main idea is to get all the feedbacks and make the documentation more useful as it can be. We need to create documentation that covers the following:

  • Install and Compile the Project Locally
    • Detailed steps on how to set up the development environment.
    • Instructions on dependencies and tools needed for the project.
    • Commands and configurations required to compile the project.
  • Create or Change a New Security Scan
    • Instructions on how to add a new security scan.
    • Steps to modify existing security scans.
    • Guidelines on best practices for creating effective security scans.

Your feedback is important to make this documentation as useful as possible. Please share your thoughts and suggestions for improvement.

@emmanuelgautier emmanuelgautier added the documentation Improvements or additions to documentation label Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant