diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..c2ebaabc --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,15 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, 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, or religion. + +Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be 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 opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.1.0, available at [http://contributor-covenant.org/version/1/1/0/](http://contributor-covenant.org/version/1/1/0/) diff --git a/LICENSE b/LICENSE index be5636ac..94eb5c0d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,6 @@ -Copyright 2015 Envato +Copyright (c) 2016 Envato + +MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/README.md b/README.md index c71841c6..a9f84ddd 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,37 @@ -# guide-gem -Document your application with a living component library and styleguide. +# Guide gem +Document your entire Rails application, not just its styles. -### Running test app -**Terminal** -- `bundle install` -- `cd spec/test_app` -- `rails s` +## Development Status [![Build status](https://badge.buildkite.com/277fd82c44a19eb19ac9a25a71df482cb7711c63ddf9bca3d3.svg)](https://buildkite.com/envato-marketplaces/guide) +Guide is extracted from production code in use at Envato. However, it is undergoing early development, and APIs and features are almost certain to be in flux. -**Browser** -- `http://localhost:3000/guide/structures/friendly/example` +## Getting Started +TBD -### JavaScript Assets +## Configuration +TBD -This app uses `browserify` to bundle client-side JavaScript files. +## Maintainers +- [Luke Arndt](https://github.com/lukearndt) +- [Jordan Lewis](https://github.com/jordanlewiz) -To start adding new JavaScript file to the project, simply add it to `javascript/application.js`. Source code will be compiled to `app/assets/javascripts/guide/application` and load through `<%= javascript_include_tag "guide/application" %>`. +## License +Guide uses the MIT license. See [LICENSE.txt](https://github.com/envato/guide/blob/master/LICENSE.txt) for details. -* `npm install` to install dependencies -* `npm run watch` to start live-reload watchify serer -* `npm run build` to build production assets(this is what being used and publish to the gem) -* `npm run lint` to fix javascript code styles +## Contact +- [github project](https://github.com/envato/guide) +- Bug reports and feature requests are via [github issues](https://github.com/envato/guide/issues) + +## Code of conduct +We welcome contribution from everyone. Read more about it in +[`CODE_OF_CONDUCT.md`](https://github.com/envato/guide/blob/master/CODE_OF_CONDUCT.md) + +## Contributing +1. Fork it ( http://github.com/envato/guide/fork ) +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request + +For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction + +Please see the [Wiki](https://github.com/envato/guide/wiki/Contributing) for indepth instructions on developing and understanding the Guide gem.