-
Notifications
You must be signed in to change notification settings - Fork 3
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
Kate Klemp
committed
Mar 6, 2016
1 parent
28b67de
commit e2a781a
Showing
4 changed files
with
106 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,23 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. | ||
|
||
**Examples of unacceptable behavior by participants include:** | ||
|
||
- The use of sexualized language or imagery | ||
- Personal attacks | ||
- Trolling or insulting/derogatory comments | ||
- Public or private harassment | ||
- Publishing other's private information, such as physical or electronic addresses, without explicit permission | ||
- Other unethical or unprofessional conduct | ||
- Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer at [kate@indiekate.com](mailto:kate@indiekate.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant, version 1.3.0, available from http://contributor-covenant.org/version/1/3/0/ |
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,21 @@ | ||
# Contributing to LightSwitch | ||
|
||
Thanks for contributing! | ||
|
||
## Table of Contents | ||
- Code of Conduct | ||
- Testing | ||
- Submitting Changes | ||
- Coding conventions | ||
|
||
### Code of Conduct | ||
|
||
The LightSwitch [code of conduct](CODE_OF_CONDUCT.md) is adapted from the the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/). Please adhere to these guidelines when contributing to the project. Violations of this code of conduct should be reported to [Kate Klemp](kate@indiekate.com). | ||
|
||
### Testing | ||
|
||
COMING SOON - no testing is currently in place on LightSwitch (feel free to contribute some testing!) | ||
|
||
### Submitting Changes | ||
|
||
Contributions should be sent via [GitHub pull request](http://help.github.com/pull-requests/) through this project repository. |
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,8 @@ | ||
# The MIT License (MIT) | ||
Copyright (c) 2016 Kate Klemp | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
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 |
---|---|---|
@@ -1,2 +1,55 @@ | ||
# lightswitch | ||
# Project Title | ||
|
||
A lightweight HTML5 single-page website using jQuery templating to switch content | ||
|
||
### Prerequisities | ||
|
||
* A server for local development (I recommend [node.js http-server](https://www.npmjs.com/package/http-server) because it's fast and easy) | ||
* A text editor or your preferred IDE | ||
* A browser that renders Javascript | ||
|
||
### Installing | ||
|
||
Clone the repo locally, navigate to the repo folder, fire up your web server, view in the browser, edit in your IDE | ||
|
||
The initial version has no styling or templating; this is meant to be as bare a repo as possible while still maintaining simple HTML5 standards, semantic elements, and a simple div to switch content out on-click of nav elements. I have included several pages for demonstration. | ||
|
||
## Running the tests | ||
|
||
*Coming soonish, not in v0.1.0* | ||
|
||
## Deployment | ||
|
||
FTP or your choice of deploy process - this is meant to be a vanilla install with all working parts in tact, without a strong opinion about deployment or environment setup | ||
|
||
## Built With | ||
|
||
* [Atom Editor](https://atom.io/) | ||
* [jQuery.loadTemplate](https://github.com/codepb/jquery-template) | ||
* [html5Doctor HTML5 boilerplate](http://html5doctor.com/html-5-boilerplates/) | ||
* [PureCSS](http://purecss.io/) | ||
* [jQuery v2.2.1 CDN](https://code.jquery.com/) | ||
|
||
|
||
## Contributing | ||
|
||
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. | ||
|
||
## Versioning | ||
|
||
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kateklemp/lightswitch/tags). | ||
|
||
## Authors | ||
|
||
* **Kate Klemp** - *Initial work* - [kateklemp](https://github.com/kateklemp) | ||
|
||
See also the list of [contributors](https://github.com/kateklemp/lightswitch/contributors) who participated in this project. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details | ||
|
||
## Acknowledgments | ||
|
||
* [OpenGovernment's Contributing Documentation](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md) | ||
* [Atom Editor's Contributing Documentation](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) |