Contribute

This site is for the collaborative development of the Federal Identity, Credential and Access Management segment architecture. The content is supporting the creation of Version 3.0 (and future revisions) of the FICAM Roadmap and Implementation Guidance v2.0, Sections 1, 2, 3 and 4.

How to Contribute

Thank you for considering contributing to our development of open and transparent architecture. To contribute to this site, please leverage the information provided below, and visit the GitHub repository which houses the source files for the site and exists here. If you have any questions, feel free to open an issue under the ‘Issues’ tab of the repository. Please note that opening issues or adding content to the repository will require the creation of a GitHub account.

GitHub issues are the primary way of sharing information and discussing this site with the broader community. For example, they should be used for:

• Suggestions: You would like to suggest an edit or addition to any existing pages or information on this site
• Corrections: You have identified a problem with existing information on the site and would like to discuss a correction

Each issue that you open should be named to clearly align with its primary topic, and tracked so that you can discuss the issue with other contributors and follow any updates. All suggestions and corrections should be stated clearly, with any links or other relevant information included in the issue.

Direct changes and line edits to the content may be submitted by clicking ‘Edit this page’. You do not need to install any software to submit content. You can use GitHub’s in-browser editor to edit files and submit a pull request for your changes to be merged.

If at any point you have a question during the contribution process, do not hesitate to open an issue requesting clarification.

Additional repositories are under development for contributors to share ICAM implementation guidance, code, reference implementations, and solutions.

Notes on Using This Repository

• pages contains markdown pages for the architecture Overview, Conceptual Diagram, Goals & Objectives, Business Process Diagram, and Applications Diagrams
• usecases contains markdown pages for each of the use cases identified to date by the Architecture & Playbook Tiger Team
• services contains markdown pages for each of the service areas (Identity, Credential, Access, & Federation)
• All diagrams and images should be placed in img

We encourage you to read our LICENSE and our README, which exist within this repository.

General Practices

This content is Vendor neutral. Marketing materials for Commercial Products should not be submitted. If you would like to contribute a page or content which includes Commercial Products and specific references for development and engineering, please review the Commercial Product trademark or copyright guides from the Product Vendor and reference those guides in your Pull Request.

Plain Language

Contributors should consider the audience when submitting content. Plain language benefits a broad audience. Review your proposed content for use of acronyms and specialized jargon before submitting.

Thanks

The idea for providing this content as open source, the contributing framework, and the licensing framework are based on work from 18F.