Skip to content
Permalink
Browse files

Add very bare-bones contributing document

  • Loading branch information...
David Woodruff
David Woodruff committed Sep 2, 2017
1 parent 6bdfa90 commit 3f1f63156a2c363303726322fe9f2c79fea20ad8
Showing with 18 additions and 1 deletion.
  1. +17 −0 CONTRIBUTING.md
  2. +1 −1 README.md
@@ -0,0 +1,17 @@
# Contributing
Thanks for wanting to help improve Handel! This page contains information you should know before contributing to Handel.

# Project Vision
The Handel project has a few goals:

* Sit at a higher level of abstration than vanilla CloudFormation to provide an easier user experience.
* Automatically and securely wire together services on behalf of users.
* Be organization-agnostic so Handel can be used by many different entities.

When contributing to Handel, please keep these goals in mind, as pull requests that run counter to these goals will likely be rejected. Handel's desire is to be an easier and more enjoyable experience than using vanilla CloudFormation.

## Reporting Bugs and Feature Requests
To report a bug or request a feature, submit a GitHub issue. One of the project maintainers will scrub the issue, discuss it, and schedule it on the roadmap if it makes sense to include in the project.

## Project Documentation
If you would like to contribute a pull request to Handel, read through the pages on the [repository wiki](https://github.com/byu-oit/handel/wiki) first. This wiki contains pages that detail the internal architecture of Handel.
@@ -9,7 +9,7 @@ resources, automatically wiring up the painful security bits between resources.
See the [Handel docs](https://handel.readthedocs.io) on ReadTheDocs for documentation on this library.

# Contributing
See the [Wiki](https://github.com/byu-oit-appdev/handel/wiki) for information on contributing to Handel.
See the [Contributing](CONTRIBUTING.md) page for information on contributing to Handel.

# Credits
The concepts in this library were originally introduced by the platform engineers at [FamilySearch](https://familysearch.org/). I've adapted their concept of Blueprints for use in this library.

0 comments on commit 3f1f631

Please sign in to comment.
You can’t perform that action at this time.