Skip to content

Commit

Permalink
update README, COC, CONTRIB add bin/setup
Browse files Browse the repository at this point in the history
  • Loading branch information
matthutchinson committed May 20, 2018
1 parent a7b517a commit 56a0626
Show file tree
Hide file tree
Showing 8 changed files with 245 additions and 208 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Expand Up @@ -7,6 +7,5 @@
/pkg/
/spec/reports/
/tmp/
coverage
config
/coverage/
*.gemfile.lock
77 changes: 45 additions & 32 deletions CHANGELOG.md
@@ -1,44 +1,57 @@
### ActsAsTextcaptcha Change Log
# ChangeLog

All notable changes to this project will be documented in this file. This
project adheres to [Semantic Versioning][Semver].
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](KeepAChangelog) and this project
adheres to [Semantic Versioning](Semver).

## [Unreleased]

* Your contribution here!
- Your contribution here!

## [4.2.0] - 2018-01-17
### Changed
- Updated Rubies for Travis CI.
- Update tests to remove MiniTest warnings.
- Latest Rails (~> 5.1.4) now set in gemspec.

## [4.1.3] - 2016-0-28
### Changed
- Updated gem dependencies.
- Switched from FakeWeb to Webmock.
- Cleaned up Rakefile.
- README now in markdown, badges fixed up.

## [4.2.0][] (17 Jan 2018)
* Updated Rubies for Travis CI
* Update tests to remove MiniTest warnings
* Latest Rails (~> 5.1.4) now set in gemspec
### Added
- bin/console
- MIT license and Code of Conduct.

## [4.1.3][] (28 May 2016)
* Updated gem dependencies
* Switched from FakeWeb to Webmock
* Added bin/console
* Cleaned up Rakefile
* Added MIT license and Code of Conduct
* README now in markdown, badges fixed up
* Removed Pry gem (development dependency)
### Removed
- Pry gem (dev dependency)

## [4.1.2][] (11 May 2014)
* Updated gem dependencies
* Added `rake console` for helpful debugging
## [4.1.2] - 2014-05-11
### Changed
- Updated gem dependencies.

## [4.1.1][] (13 January 2014)
* Dropped gem [signing & cert](http://tinyurl.com/p98owwz)
### Added
- `rake console` for helpful debugging.

## [4.1.0][] (2 January 2014)
* Dropping support for Rails 2
* README updated
* CHANGELOG (this file) added
## [4.1.1] 2014-01-13
### Removed
- gem [signing & cert](http://tinyurl.com/p98owwz).

## [4.0.0][] (1 January 2014)
* Using a cache store to persist answers between requests
* README updated
* Test coverage improved
## [4.1.0] - 2014-01-02
### Added
- CHANGELOG (this file) added.

(further change log details for older releases are unavailable)
### Removed
- Support for Rails 2.

## [4.0.0] - 2014-01-01
### Changed
- Using a cache store to persist answers between requests.
- README updated.
- Test coverage improved.

[Unreleased]: https://github.com/matthutchinson/acts_as_textcaptcha/compare/v4.2.0...HEAD
[4.2.0]: https://github.com/matthutchinson/acts_as_textcaptcha/compare/v4.1.3...v4.2.0
Expand All @@ -47,5 +60,5 @@ project adheres to [Semantic Versioning][Semver].
[4.1.1]: https://github.com/matthutchinson/acts_as_textcaptcha/compare/v4.1.0...v4.1.1
[4.1.0]: https://github.com/matthutchinson/acts_as_textcaptcha/compare/v4.0.0...v4.1.0
[4.0.0]: https://github.com/matthutchinson/acts_as_textcaptcha/compare/v3.0.11...v4.0.0

[Semver]: http://semver.org
[KeepAChangelog]: http://keepachangelog.com/en/1.0.0/
[Semver]: http://semver.org/spec/v2.0.0.html
84 changes: 54 additions & 30 deletions CODE_OF_CONDUCT.md
@@ -1,50 +1,74 @@
# Contributor Code of Conduct
# Contributor Covenant 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.
## Our Pledge

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.
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance, race,
religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing other's private information, such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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.
## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting a project maintainer via [GitHub][maintainer]. All
reported by contacting the project team at via [Github][maintainer]. 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.
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.3.0, available at
[http://contributor-covenant.org/version/1/3/0/][version]
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
[maintainer]: https://github.com/matthutchinson
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/3/0/
23 changes: 14 additions & 9 deletions CONTRIBUTING.md
@@ -1,30 +1,35 @@
### Contributing

Pull Requests are welcome! To start helping out on this project:
Pull Requests are welcome! To get started:

Fork then clone the repository:
[Fork](https://guides.github.com/activities/forking) then clone the repository:

git clone git@github.com:your-username/acts_as_textcaptcha.git

Create your feature branch:

git checkout -b my-new-feature

Commit your changes, push and submit a new [Pull
Request](https://github.com/matthutchinson/acts_as_textcaptcha/compare/):
When you are happy with your change, run the full test suite:

bundle exec rake

With a passing test suite, commit your changes, push and submit a new [Pull
Request](https://github.com/matthutchinson/acts_as_textcaptcha/compare):

git commit -am 'Added some feature'
git push origin my-new-feature

At this point you'll be waiting for me to review it. I try to reply to new Pull
Requests within 5 days. I may suggest some changes, improvements or
alternatives. To increase the chance that your pull request gets accepted:
At this point you'll be waiting for one of our maintainers to review it. We will
try to reply to new pull requests within a few days. We might suggest some
changes, improvements or alternatives. To increase the chance that your pull
request gets accepted:

* Explain what your are doing (and why) in your Pull Request description.
* Explain what your are doing (and why) in your pull request description.
* If you are fixing an
[issue](https://github.com/matthutchinson/acts_as_textcaptcha/issues), link to
it in your description and [mention
it](https://help.github.com/articles/closing-issues-via-commit-messages/) in
it](https://help.github.com/articles/closing-issues-via-commit-messages) in
the commit message.
* Write a good [commit
message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
Expand Down

0 comments on commit 56a0626

Please sign in to comment.