fix(id-card, citizenship): adding readme

[berglindoma13]

...

Attach a link to issue if relevant

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• Formatting passes locally with my changes
• I have rebased against main before asking for a review

Summary by CodeRabbit

• Documentation
  • Added new sections: "ID CARD APPLICATION," "About," "URLs," "Project owner," and "Code owners and maintainers" in the README files for both the Directorate of Immigration and ID Card applications.
  • Updated the introductory content to provide clearer descriptions of the applications.
  • Removed outdated instructions for running unit tests to streamline documentation.

[coderabbitai]

Walkthrough

The changes involve significant updates to the README.md files for two libraries: the Directorate of Immigration's Citizenship application and the ID Card application. Each file now includes new sections such as "ID CARD APPLICATION," "About," "URLs," "Project owner," and "Code owners and maintainers," providing clearer documentation. The previous "Running unit tests" section has been removed from both files, reflecting a shift in focus away from testing instructions.

Changes

File Path	Change Summary
libs/application/templates/directorate-of-immigration/citizenship/README.md	- Added sections: "ID CARD APPLICATION," "About," "URLs," "Project owner," "Code owners and maintainers" - Removed "Running unit tests" section.
libs/application/templates/id-card/README.md	- Title changed to "ID CARD APPLICATION" - Added sections: "About," "URLs," "Project owner," "Code owners and maintainers" - Removed "Running unit tests" section.

Possibly related PRs

• fix(citizenship): validation update #14937: This PR updates the CitizenshipService class, which is part of the same module as the main PR, indicating a focus on citizenship-related functionality.
• fix(citizenship): error with given and family names on prod #15865: Changes in the citizenship.service.ts file regarding name handling are relevant as they pertain to the citizenship module, which is the context of the main PR.
• fix(citizenship): wrong path error fix #16251: This PR addresses a wrong path error within the citizenship module, indicating a direct connection to the same functionality as the main PR.
• fix(citizenship): indexing error on child support documents #16469: This PR modifies components related to child support documents within the citizenship module, which aligns with the context of the main PR.
• fix(citizenship): condition for children support documents #16607: Changes to the ChildrenOtherDocumentsSubSection component in this PR relate to the citizenship module, making it relevant to the main PR.

Suggested labels

automerge

Suggested reviewers

• sigruntg
• kksteini

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.