Skip to content

Commit

Permalink
Add base files
Browse files Browse the repository at this point in the history
  • Loading branch information
jimbydamonk committed Jul 1, 2016
1 parent b9e1c68 commit 04f5acd
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 0 deletions.
10 changes: 10 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Credits

## Development Lead

- Mike Buzzetti <michael.buzzetti@nytimes.com>
- Scott Stevenson <scott.stevenson@nytimes.com>

## Contributors

None yet. Why not be the first?
81 changes: 81 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

## Types of Contributions

### Report Bugs

Report bugs at https://github.com/jimbydamonk/mock-ec2-metadata/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

### Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.

### Implement Features

Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.

### Write Documentation

mock-ec2-metadata could always use more documentation, whether as part of the
official mock-ec2-metadata docs, in docstrings, or even on the web in blog posts,
articles, and such.

### Submit Feedback

The best way to send feedback is to file an issue at https://github.com/jimbydamonk/mock-ec2-metadata/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)

## Get Started!

Ready to contribute? Here's how to set up `mock-ec2-metadata` for local development.

1. Fork the `mock-ec2-metadata` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/mock-ec2-metadata.git

3. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

4. When you're done making changes, check that your changes pass the tests::

$ make test

6. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.md.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# mock-ec2-metadata

A simple service to mock the ec2 metadata service.

## Getting started

This project requires Go to be installed. On OS X with Homebrew you can just run `brew install go`.

Running it then should be as simple as:

```console
$ make
$ ./bin/mock-ec2-metadata
```


### Testing

``make test``

## License

See `LICENSE`

## Contributing

See `CONTRIBUTING.md` for more details.

0 comments on commit 04f5acd

Please sign in to comment.