How to Contribute
Thank you for considering contributing to our development of open and transparent Federal PKI Guides. Everyone has tricks and tips and we want to share these with our colleagues!
To contribute to this site, you can:
Using GitHub as a first time user can be overwhelming. An introduction video is available from DigitalGov on YouTube: Introduction to GitHub.
Open an Issue
Issues are the primary way of sharing information and discussing this site with the broader community. For example, Issues can 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
Issues may be submitted by clicking Submit Issues Here in the bottom of the left side navigation.
For a quick guide on opening Issues, read how to open issues.
Edit an existing page
Direct changes and line edits to the content may be submitted by clicking Edit this page in the top right hand corner of each 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 the changes for discussion.
For a quick guide on editing a page, read how to edit a page.
Add a new page
We welcome new pages and appreciate your contributions!
First, propose a topic by opening an Issue. If you don’t have a topic, a good place to start is by reviewing the existing Issues lists.
Choose one of the Issues and start a conversation on the Issue. You help clarify the problem and identify the solution by discussing the Issue first, and you can propose a format for the new page. When you are ready, add a comment to the Issue that you would like to write up the solution! We will create a new branch for you if needed.
For a quick guide on adding a page, read how to add a page.
We have a sample template with markdown samples.
Notes on using this repository
In the GitHub repository here under the ‘Code’ tab:
There are folders containing the content and diagrams.
- pages: includes the content on the pages
- img: includes all diagrams and images and are available for download and reuse anywhere
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.
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.
- All pages should be brief.
- Use titles to help the user identify jumping off points for information.
- Paragraphs should be short.
- All text should be written in plain language and in a user-friendly active voice as much as possible.
- Use numbered steps, bullet lists, and graphics.
The following sources can provide additional help with plain language, writing, and style:
The idea for providing this content as open source, the contributing framework, and the licensing framework are based on work from 18F