Skip to content

Commit

Permalink
Introduced contributions.
Browse files Browse the repository at this point in the history
  • Loading branch information
technion committed Feb 23, 2016
1 parent b0eb554 commit e6a0e08
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contribution Guidelines

Any form of contribution is accepted, however, please note the following.

## Please note noncompliant issues or PRs will be closed without discussion

- Note the [Design Goals](https://github.com/technion/ruby-argon2/blob/master/README.md#design) documented for the project and work within them
- Commits should be squashed to a single commit per pull. An exception is that a test suite add or change, followed by code update, may be presented as two commits in one pull
- Each individual commit should have a descriptive commit message. "Update <file>" is not suitable
- This is a coding project. Your political goals are not relevant
- Any complex or large code will probably require a test
- If an issue is felt to be a security concern, please contact me privately on: technion@lolware.net
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,8 @@ If you are providing your own salt, you are probably using it wrong. The design

## Contributing

Any form of contribution is appreciated, however, please note the design goals above and work within them.
Any form of contribution is appreciated, however, please review [CONTRIBUTING.md](CONTRIBUTING.md).

If an issue is felt to be a security concern, please contact me privately on: technion@lolware.net. If required, you may encrypt with [my GPG key](https://lolware.net/technion-GPG-KEY).

## Building locally/Tests

Expand Down

0 comments on commit e6a0e08

Please sign in to comment.