This repository has been archived by the owner on Sep 20, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add very bare-bones contributing document
- Loading branch information
Showing
2 changed files
with
18 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters