Skip to content

Commit e6a0e08

Browse files
committed
Introduced contributions.
1 parent b0eb554 commit e6a0e08

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contribution Guidelines
2+
3+
Any form of contribution is accepted, however, please note the following.
4+
5+
## Please note noncompliant issues or PRs will be closed without discussion
6+
7+
- Note the [Design Goals](https://github.com/technion/ruby-argon2/blob/master/README.md#design) documented for the project and work within them
8+
- 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
9+
- Each individual commit should have a descriptive commit message. "Update <file>" is not suitable
10+
- This is a coding project. Your political goals are not relevant
11+
- Any complex or large code will probably require a test
12+
- If an issue is felt to be a security concern, please contact me privately on: [email protected]

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,8 @@ If you are providing your own salt, you are probably using it wrong. The design
9898

9999
## Contributing
100100

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

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

105104
## Building locally/Tests
106105

0 commit comments

Comments
 (0)