Skip to content

Commit 27af01d

Browse files
fboemerkarulont
andauthored
Add contributing guide (#6)
* Add contributing guide Co-authored-by: Karl Tarbe <[email protected]>
1 parent af251f7 commit 27af01d

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Contributing to Swift Homomorphic Encryption
2+
3+
Welcome to the Swift Homomorphic Encryption community! Thanks for your interest in contributing. We would love contributions in the form of feedback via [GitHub Issues](https://github.com/apple/swift-homomorphic-encryption/issues), pull requests with new features, bug fixes, documentation (including fixing typos!), and your ideas. If it's a big change, please start with an Issue.
4+
5+
### Pull Requests:
6+
Before making a commit for a pull request, please run `pre-commit install`.
7+
Then on each commit some basic formatting checks will be run.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Two ways to run the benchmarks are:
167167
* See the [Benchmark](https://github.com/ordo-one/package-benchmark) documentation for more information on running benchmarks.
168168

169169
### Contributing
170-
If you would like to make a pull request to Swift Homomorphic Encryption, please run `pre-commit install`. Then each commit will run some basic formatting checks.
170+
If you are interested in making a contribution to Swift Homomorphic Encryption, see our [contributing guide](CONTRIBUTING.md).
171171

172172
# Documentation
173173
Swift Homomorphic Encryption uses DocC for documentation.

0 commit comments

Comments
 (0)