Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Latest commit

 

History

History
45 lines (25 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

45 lines (25 loc) · 2.75 KB
Raw

Welcome!

We're so glad you're thinking about contributing to an 18F open source project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.

We want to ensure a welcoming environment for all of our projects. Our staff follow the 18F Code of Conduct and all contributors should do the same.

We encourage you to read this project's CONTRIBUTING policy (you are here), its LICENSE, and its README.

If you have any questions or want to read more, check out the 18F Open Source Policy GitHub repository, or just shoot us an email.

How to contribute

Public domain

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Issues

If there’s anything you’d like to understand about 18F's visual design, brand, or assets, submit an issue about it. If you see something that should be fixed but don’t want to do so yourself, submit an issue. If you have an idea for an improvement... well, you get the idea.

What to include in an issue

Not all of these will apply to all issues. But when they do, it’s very helpful to see them (special thanks to @ondrae for the suggestion of this list).

  • Description: okay, this one does apply to all issues. :)
  • How to reproduce: if your issue is a bug, any information about how we can see it ourselves
  • Screenshots: similarly, so we can see what you’re seeing
  • Files: anything with helpful information about the issue
  • To dos: if your issue is an enhancement, a list of improvements or steps to help us meet the goal of the enhancement

If your issue is a request for a new teamplate or asset, tell us about what you need, and how it would be useful to you.

Where to submit a pull request

Submit pull requests to the master branch. This is the main branch. If you’re not sure how to submit a pull request, feel free to submit an issue and we will try to address it ourselves.

What to include in a pull request

Including these will help us be faster and better at responding.

  • Changes: a list, preferably bulleted, of what you’re changing
  • Notes: anything that might help us understand the change, like why you’re doing it or alternative approaches you tried
  • Screenshots: if your pull request will affect layout or interaction, to show us what you’re fixing or changing