Skip to content

Commit

Permalink
Add initial project docs
Browse files Browse the repository at this point in the history
Copied from 18F/atf-eregs --- these all need to be updated
  • Loading branch information
CM Lubinski committed Jan 11, 2017
0 parents commit 2c6b15a
Show file tree
Hide file tree
Showing 7 changed files with 550 additions and 0 deletions.
128 changes: 128 additions & 0 deletions .about.yml
@@ -0,0 +1,128 @@
---
# .about.yml project metadata

# This is a short name of your project that can be used as a URL slug.
# (required)
name: atf-eregs

# This is the display name of your project. (required)
full_name: ATF eRegulations

# What is the problem your project solves? What is the solution? (required)
description: The Bureau of Alcohol, Tobacco, Firearms and Explosives (ATF) maintains a large amount of complex information that the public needs to use, including regulations with important requirements related to munitions, firearms, and explosives. 18F adapted and customized eRegulations, an open source project started by the Consumer Financial Protection Bureau in 2013, to make ATF's regulations easier to find, read, and understand.

# What is the measurable impact of your project? (required)
impact: We produced a web application that offers substantial support for reading complex legal information, which helps ATF serve the public.

# What kind of team owns the repository? (required)
# values: guild, working-group, project
owner_type: project

# What is your project's current status? (required)
# values: discovery, alpha, beta, live
stage: live

# Should this repo have automated tests? If so, set to `true`. (required)
# values: true, false
testable: true

# What are the licenses that apply to the project and/or its components?
# (required)
# Items by property name pattern:
# .*:
# name: Name of the license from the Software Package Data Exchange (SPDX): https://spdx.org/licenses/
# url: URL for the text of the license
licenses:
atf-eregs:
name: CC0-1.0
url: https://github.com/18F/atf-eregs/blob/master/LICENSE.md

# Who is the partner for your project? (Use the full name of the partner
# documented here:
# https://github.com/18F/dashboard/blob/staging/_data/partners.yml)
partners:
- Bureau of Alcohol, Tobacco, Firearms and Explosives

# The main point of contact(s) and/or the issue reporting system for your
# project, and either a `mailto:` link or URL for each contact.
# Items:
# - url: URL for the link
# text: Anchor text for the link
contact:
- url: https://github.com/18F/atf-eregs/issues
text: GitHub issues

# Who are the team members on your project? You can specify GitHub usernames,
# email addresses, or other organizational usernames. (required)
# Items:
# - github: GitHub user name
# id: Internal team identifier/user name
# role: Team member's role; leads should be designated as 'lead'
team:
- github: brittag
role: Content Designer
- github: cmc333333
role: Engineer
- github: jbarnicle
role: Engineer
- github: jehlers
role: User Experience Designer
- github: journerdism
role: Product Manager
- github: tadhg-ohiggins
role: Engineer
- github: theresaanna
role: Engineer
- github: vrajmohan
role: Engineer

# What kind of content is contained in the project repository?
# values: app, docs, policy
type: app

# What are the key milestones you've achieved recently?
#milestones:
#-

# Name of the main project repo if this is a sub-repo; name of the grouplet
# repo if this is a working group/guild subproject
#parent:

# What are the links to key artifacts associated with your project? e.g. the
# production site, documentation.
# Items:
# - url: URL for the link
# text: Anchor text for the link
# category: Type of the link
links:
- url: https://atf-eregs.apps.cloud.gov/
text: ATF eRegulations website

# What tags does your organization's blog associate with your project? You can
# find a list of 18F blog tags here: https://18f.gsa.gov/tags/
#blogTag:
#-

# What technologies are used in this project?
#stack:
#-

# What are the services used to supply project status information?
# Items:
# - name: Name of the service
# category: Type of the service
# url: URL for detailed information
# badge: URL for the status badge
#services:
#-

# Organizations or individuals who have adopted the project for their own use
# Items:
# - id: The name of the organization or individual
# url: A URL to the user's version of the project
#users:
#-

# Tags that describe the project or aspects of the project
#tags:
#-
2 changes: 2 additions & 0 deletions .bandit
@@ -0,0 +1,2 @@
[bandit]
skips: B101
35 changes: 35 additions & 0 deletions LICENSE.md
@@ -0,0 +1,35 @@
# Public domain

As a work of the United States Government, this project is in the
public domain within the United States.

Additionally, we waive copyright and related rights in the work
worldwide through the CC0 1.0 Universal public domain dedication.

## CC0 1.0 Universal Summary

This is a human-readable summary of the
[Legal Code (read the full
text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).

### No Copyright

The person who associated a work with this deed has dedicated the work to
the public domain by waiving all of his or her rights to the work worldwide
under copyright law, including all related and neighboring rights, to the
extent allowed by law.

You can copy, modify, distribute and perform the work, even for commercial
purposes, all without asking permission.

### Other Information

In no way are the patent or trademark rights of any person affected by CC0,
nor are the rights that other persons may have in the work or in how the
work is used, such as publicity or privacy rights.

Unless expressly stated otherwise, the person who associated a work with
this deed makes no warranties about the work, and disclaims liability for
all uses of the work, to the fullest extent permitted by applicable law.
When using or citing the work, you should not imply endorsement by the
author or the affirmer.
27 changes: 27 additions & 0 deletions README.md
@@ -0,0 +1,27 @@
# ATF eRegulations
This repository contains code necessary to run a Bureau of Alcohol,
Tobacco, Firearms and Explosives ([ATF](https://www.atf.gov)) instance of
[eRegulations](https://eregs.github.io) (a regulation parser, API, and viewer). Live version: [https://atf-eregs.apps.cloud.gov/](https://atf-eregs.apps.cloud.gov/)

This code glues together general-purpose/non-agency-specific eRegulations libraries (which are not in this repository) with ATF-specific styles, templates, and plugins (which are in this repository).

## Status
[![Build Status](https://travis-ci.org/18F/atf-eregs.svg?branch=master)](https://travis-ci.org/18F/atf-eregs)
[![Quantified Code](https://www.quantifiedcode.com/api/v1/project/e2ee92b5c3db486f89d47371c4d89a2f/badge.svg)](https://www.quantifiedcode.com/app/project/e2ee92b5c3db486f89d47371c4d89a2f)
[![Dependency Status](https://gemnasium.com/18F/atf-eregs.svg)](https://gemnasium.com/18F/atf-eregs)

## Documentation and contributing

See the [eRegulations overview](https://eregs.github.io/) for context about eRegulations, which is a multi-agency project.

To learn how to set up ATF eRegulations (locally or in production) and customize it/develop for it, see [the documentation hosted on Read the Docs](https://atf-eregs.readthedocs.org/).

If you're interested in contributing to ATF eRegulations, see [the contributing guidelines](CONTRIBUTING.md).

## Public domain

This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):

> This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
>
> 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.

0 comments on commit 2c6b15a

Please sign in to comment.