How to Contribute
Thank you for considering contributing to our development of open and transparent PACS 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 to share information and discuss this site with the broader community. You can use issues for:
- Suggestions: You want to suggest an edit or addition to existing information on this site.
- Corrections: You identified a problem with existing information on the site and want to discuss a correction.
To submit an issue, click Submit Issues Here in the left navigation bar.
For a quick guide on opening issues, read how to open issues.
Edit an existing page
You can submit direct changes and line edits to the content. Click Edit this page in the upper right corner of the page you want to modify. You don’t 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. By creating or discussing an issue, you can clarify the problem, identify the solution, and propose a format for the new page. When you’re ready, post a comment on the issue that you want to write 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, on the Code tab, you can view the folder structure of this website:
The following folders contain the content and diagrams:
- pages: includes the Introduction, Identifiers, Getting Started, and Certificate Trust pages.
- img: includes all diagrams and images, which are available for download and reuse anywhere.
This content is vendor-neutral. You should not submit marketing materials for commercial products. If you want to contribute a page or content that 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.
Consider the audience when you submit content. Plain language benefits a broad audience. Review your proposed content for use of acronyms and specialized jargon before submitting.
- Make each page brief.
- Use titles to help the user identify jump-off points for information.
- Write short paragraphs.
- Write in plain language and 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.