Skip to content

Opensource gfmodules-functional-documentation #20

@Chocolate7

Description

@Chocolate7

We hebben akkoord van de stakeholder om gfmodules-functional-documentation te opensourcen.

Opensource Checklist

Before making any updates to a public project repository, ensure that all necessary steps are taken to maintain code integrity, licensing compliance, and documentation accuracy. Use this checklist as a guide, and provide the necessary information:

  • Update Documentation: Review and update project documentation to reflect any changes made in the codebase.
  • Sanity check the code and commits: Perform a thorough review of the code and commits to ensure consistency and correctness.
  • Check license file(s) and correct if needed: Check the license file(s) associated with the project and make corrections if necessary to ensure compliance.
  • Code review by security team: Request a code review by the security team to identify and address any potential security vulnerabilities. Include the security test results.
  • Readme check: Verify the Readme file for completeness and clarity, ensuring it provides necessary information for users and contributors.
    • Readability (use of domain terminology): Evaluate the readability of the code, ensuring the consistent use of domain-specific terminology.
    • Functionality Test: Verify that the application functions correctly by testing its functionality. Include the test rapport Test Report.
  • Dependency Review: Conduct a review of external code dependencies to ensure quality and security standards are met.
  • Determine repository synchronisation scheme (with or without history): Determine the synchronization scheme for the repository, whether with or without history, to align with project requirements.
  • Create Public Repository: Establish a public repository for the project, implementing necessary branch protection measures.
  • Get written approval: Obtain written approval from the product owner and Informatiebeveiliging Management Forum (IBMF).
    • Product owner
    • IBMF, add screenshot of checklist and explanation of any unchecked or striked out items.
  • Update GitHub Actions: Adjust GitHub Actions configurations to eliminate the use of organization or repository secrets for enhanced security.
  • Configuration for Public Use: Configure the repository to be accessible and usable by the public, ensuring appropriate settings are in place.
  • Celebrate: Acknowledge the successful completion of the update process with a celebratory gesture.

🎉 Let's celebrate the progress! 🎉`

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions