This repository was archived by the owner on May 8, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 70dfb57
Showing
137 changed files
with
12,537 additions
and
0 deletions.
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,102 @@ | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
env/ | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*,cover | ||
.hypothesis/ | ||
test-results.xml | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# Sceptre directories users may have for testing | ||
/config | ||
/templates | ||
|
||
### OSX ### | ||
*.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
|
||
# Icon must end with two \r | ||
Icon | ||
|
||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear in the root of a volume | ||
.DocumentRevisions-V100 | ||
.fseventsd | ||
.Spotlight-V100 | ||
.TemporaryItems | ||
.Trashes | ||
.VolumeIcon.icns | ||
.com.apple.timemachine.donotpresent | ||
|
||
# Directories potentially created on remote AFP share | ||
.AppleDB | ||
.AppleDesktop | ||
Network Trash Folder | ||
Temporary Items | ||
.apdisk | ||
|
||
### PyCharm ### | ||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm | ||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 | ||
|
||
# User-specific stuff: | ||
.idea/ | ||
|
||
## File-based project format: | ||
*.iws |
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,26 @@ | ||
======= | ||
Credits | ||
======= | ||
|
||
Owner | ||
----- | ||
|
||
* Henry Bell `@henrybell <https://github.com/henrybell>`_ | ||
|
||
Development Leads | ||
----------------- | ||
|
||
* James Routley `@jamesroutley <https://github.com/jamesroutley>`_ | ||
* Sean Rankine `@theseanything <https://github.com/theseanything>`_ | ||
|
||
Contributors | ||
------------ | ||
|
||
* Olivier Van Goethem `@oliviervg1 <https://github.com/oliviervg1>`_ | ||
* Adrian Fernandez `@afdezl <https://github.com/afdezl>`_ | ||
* Luke Plausin `@lukeplausin <https://github.com/lukeplausin>`_ | ||
* Amy Bruce-Gardner <[email protected]> | ||
* Marius Galbinasu `@galbinasu <https://github.com/galbinasu>`_ | ||
* Matthew Taylor <[email protected]> | ||
* Yvonne Beumer <[email protected]> | ||
* Max Eskenazi <[email protected]> |
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,112 @@ | ||
.. highlight:: shell | ||
|
||
======================= | ||
Contributing to Sceptre | ||
======================= | ||
|
||
* `Code of Conduct`_ | ||
* `How to Contribute`_ | ||
* `Report Bugs`_ | ||
* `Enhancement Proposal`_ | ||
* `Contributing Code`_ | ||
* `Get Started`_ | ||
* `Credits`_ | ||
|
||
|
||
Code of Conduct | ||
--------------- | ||
|
||
This project adheres to the Contributor Covenant `code of conduct <http://contributor-covenant.org/version/1/4/>`_. By participating, you are expected to uphold this code. Please report unacceptable behaviour to [email protected]. | ||
|
||
|
||
How to Contribute | ||
----------------- | ||
|
||
Report Bugs | ||
*********** | ||
|
||
Before submitting a bug, please check our `issues page <https://github.com/cloudreach/sceptre/issues>`_ to see if it's already been reported. | ||
|
||
When reporting a bug, fill out the required template, and please include as much detail as possible as it helps us resolve issues faster. | ||
|
||
|
||
Enhancement Proposal | ||
******************** | ||
|
||
Enhancement proposals should: | ||
|
||
* Use a descriptive title. | ||
* Provide a step-by-step description of the suggested enhancement. | ||
* Provide specific examples to demonstrate the steps. | ||
* Describe the current behaviour and explain which behaviour you expected to see instead. | ||
* 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. | ||
|
||
|
||
Contributing Code | ||
***************** | ||
|
||
Contributions should be made in response to a particular GitHub Issue. We find it easier to review code if we've already discussed what it should do, and assessed if it fits with the wider codebase. | ||
|
||
A good pull request: | ||
|
||
* Is clear. | ||
* Works across all supported version of Python. | ||
* Complies with the existing codebase style (`flake8 <http://flake8.pycqa.org/en/latest/>`_, `pylint <https://www.pylint.org/>`_). | ||
* Includes `docstrings <https://www.python.org/dev/peps/pep-0257/>`_ and comments for unintuitive sections of code. | ||
* Includes documentation for new features. | ||
* Includes tests cases that demonstrates the previous flaw that now passes with the included patch, or demonstrates the newly added feature. Tests should have 100% code coverage. | ||
* Is appropriately licensed (Apache 2.0). | ||
|
||
|
||
|
||
Get Started | ||
----------- | ||
|
||
1. Fork the ``sceptre`` repository on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/sceptre.git | ||
|
||
3. Install your local copy into a `virtualenv <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_. Assuming you have virtualenv installed, this is how you set up your fork for local development:: | ||
|
||
$ cd sceptre/ | ||
$ virtualenv env | ||
$ source env/bin/activate | ||
$ pip install -r requirements_dev.txt | ||
$ pip install -r requirements_tests.txt | ||
$ pip install -e . | ||
|
||
4. Create a branch for local development:: | ||
|
||
$ git checkout -b sptr-<GitHub issue number> | ||
|
||
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:: | ||
|
||
$ make lint | ||
$ make test | ||
$ make test-all | ||
$ make test-integration | ||
$ make coverage # coverage should be 100% | ||
|
||
6. Make sure the changes comply with the pull request guidelines in the section on `Contributing Code`_. | ||
|
||
7. Commit your changes:: | ||
|
||
$ git add . | ||
$ git commit | ||
|
||
Commit messages should follow `these guidelines <https://github.com/erlang/otp/wiki/Writing-good-commit-messages>`_. | ||
|
||
Push your branch to GitHub:: | ||
|
||
$ git push origin sptr-<GitHub issue number> | ||
|
||
8. Submit a pull request through the GitHub website. | ||
|
||
|
||
Credits | ||
------- | ||
|
||
This document took inspiration from the CONTRIBUTING files of the `Atom <https://github.com/atom/atom/blob/abccce6ee9079fdaefdecb018e72ea64000e52ef/CONTRIBUTING.md>`_ and `Boto3 <https://github.com/boto/boto3/blob/e85febf46a819d901956f349afef0b0eaa4d906d/CONTRIBUTING.rst>`_ projects. |
Oops, something went wrong.