Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 4.49 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 4.49 KB
Raw

Contributing to FBI Application Guide

🎉 Thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to the FBI Application Guide project on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to our Discord.

New Contributor Guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

When you have made your contribution, ensure that both the PDF and Word document have been updated.

How to Contribute

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description and as much relevant information as possible.
  • Use the issue templates to create the issue. They include step by step guidelines and have lists of things that should be included.

Did you find a spelling or grammatical error?

  • Open a new Pull Request on GitHub with the spelling error corrected.
  • Ensure both the Word document and PDF have been updated.

Did you write a patch that fixes a bug, spelling error, grammatical error or updates the documentation?

  • Open a new Pull Request on GitHub with the patch.
  • Ensure the pull request description clearly describes the problem and solution. Be sure to include a title, and as much relevant information as possible. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

  • Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of FBI Application Guide are still accepted! Just follow the same instructions as above.

Do you want to add a new section or change an existing one?

  • Ensure the section was not already introduced by searching on GitHub under Issues. Look for those under the enhancement tag.
  • If you're unable to find an open issue addressing the new section, open a new one!
  • If you have completed the section already, open a new Pull Request on GitHub with the section. Ensure it contains both Word documents and PDFs for the new section.

Do you have questions about the project?

  • Ask any question about how to use FBI Application Guide on our Discord.
  • If it does not get answered, open an issue.

Attribution

This document is adapted from the Contributing documents of Rails, the GitHub Docs, Atom, and OpenGovernment.