Skip to content

Commit 649f2f5

Browse files
Danielmohemian-92817281
Daniel
authored andcommitted
[JOSE-70] Update readme and contributing guidelines (airsidemobile#51)
* [JOSE-70] Add logo * [JOSE-70] Add readme sketch * [JOSE-70] Update toc * [JOSE-70] Update toc anchors * [JOSE-70] Add license section * [JOSE-70] Update contributing section * [JOSE-70] Add more todos * [JOSE-70] Use gh emoji syntax * [JOSE-70] Update cont. guidelines * [JOSE-70] Update wording * [JOSE-70] Update link * [JOSE-70] Move fiels to .github * [JSOE-70] Add jws sketch * [JSOE-70] Update markup * [JSOE-70] Update jws examples * [JSOE-70] Add verification example * [JSOE-70] Update usage toc * [JSOE-70] Move summary above detailed explaination * [JSOE-70] Add horizonatl lines between exampels * [JSOE-70] Remove liens again * [JSOE-70] Add encryption headers * [JSOE-70] Fix anchor * [JSOE-70] Encryption summary * [JOSE-70] Add encryption example * [JOSE-70] Add decryption example and fix some things * [JOSE-70] Add first jwk example * [JOSE-70] Add more JWK examples * [JOSE-70] Add fruther jwk stuff * [JOSE-70] Update JWK example * [JOSE-70] Add SecKey non iOS note * [JOSE-70] Update code example * [JOSE-70] Add JWK summaries * [JSOE-70] Update usage toc * [JOSE-70] Add incompleteness disclamer * [JOSE-70] Update markup * [JOSE-70] Update markup * [JOSE-70] Update markup * [JOSE-70] Add features * [JOSE-70] Add pr note * [JOSE-70] Add key note * [JOSE-70] Update logo * [JOSE-70] Fix typos * [JOSE-70] Update some things and add some emoji * [JOSE-70] Update wording * [JOSE-70] Add security section * [JOSE-70] Test out details section * [JOSE-70] Fix details section * [JOSE-70] Add spacing * [JOSE-70] Update wording * [JOSE-70] Update code * [JOSE-70] Add details section * [JOSE-70] Add encryption details section * [JOSE-70] Update examples * [JOSE-70] Update readme * [JOSE-70] Add line break * [JOSE-70] Add details section for decryption * [JOSE-70] Add details section for encoding keys * [JOSE-70] Update example * [JOSE-70] Add details section for decodin gkeys * [JSOE-70] Add resources and extend credits * [JOSE-70] Use svg logo * [JOSE-70] Remove png logo * [JOSE-70] Update contributing guidelines * [JOSE-70] Update contributing guidelines * [JOSE-70] Add light logo and move logos to dir * [JOSE-70] Fix typo * [JOSE-70] Update contributing guidelines * [JOSE-70] Update wording * [JOSE-70] Update usage toc * [JOSE-70] Update wording * [JOSE-70] Update numbering in lists * [JOSE-70] Update examples * [JOSE-70] Try out table for features * [JOSE-70] Try to fix the table * [JOSE-70] Try to fix table * [JOSE-70] Fix table * [JOSE-70] Add key encryption algorithm table * [JOSE-70] Update content encryption algorithms * [JOSE-70] Add supported JWK key types * [JOSE-70] Make tests first in pr flow * [JOSE-70] Add work in progress note * [JOSE-70] Add project authors and maintainers * [JOSE-70] Update building JWS example * [JOSE-70] Update JWS validation example * [JOSE-70] Update JWE creation example * [JOSE-70] Update JWE decryption example * [JOSE-70] Add link to wiki * [JOSE-70] Update exampel code * [JOSE-70] Resolve workd repetition * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Update wording * [JOSE-70] Shorten jws construction * [JOSE-70] Try to fix link to wiki * [JOSE-70] Remove detailed code examples * [JOSE-70] Remove key notes * [JOSE-70] Remvoe details * [JOSE-70] Add some hrs * [JOSE-70] Change some hrs * [JOSE-70] Remove some hrs * [JOSE-70] Remove JWK details * [JOSE-70] Add missing try! * [JOSE-70] Fix signing algorithm checkmark
1 parent 41d04a2 commit 649f2f5

6 files changed

+438
-63
lines changed

CODE_OF_CONDUCT.md .github/CODE_OF_CONDUCT.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,6 @@ members of the project's leadership.
6666

6767
## Attribution
6868

69-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
70-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
69+
This Code of Conduct is adapted from the [Contributor Covenant, version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
7170

72-
[homepage]: https://www.contributor-covenant.org
7371

.github/CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing to JOSESwift
2+
3+
Thanks for taking the time to contribute to the project.
4+
5+
:tada: First step done: All kinds of contributions are highly appreciated and very welcome.
6+
7+
## Code of Conduct
8+
9+
Everyone who participates in this project sticks to the [Code of Conduct](CODE_OF_CONDUCT.md).
10+
11+
## I want to contribute, but how?
12+
13+
For feature contributions or bug fixes, please submit a pull request. For feature requests, discussions or bug reports, just open an issue.
14+
15+
### Pull Request Process
16+
17+
1. If applicable, make sure your pull request includes tests that thoroughly cover newly added lines.
18+
2. Please don’t forget to update the [README.md](../README.md) and other documentation with relevant details of changes.
19+
3. Submit your pull request to `master`.
20+
4. Provide a detailed description of your changes in the pull request description. Reference any resolved issues or previous discussions in other pull requests.
21+
5. Pull requests will need to be approved before being merged. The better the pull request description, the easier and quicker a pull request will be to review.
22+
6. Once approved, the pull request can be squash merged into master and we’re done. :tada:
23+
24+
### General
25+
26+
Please make sure to stick to general coding best practices and Swift code style as good as possible. You can find more info on that in GitHub’s [Swift Style Guide](https://github.com/github/swift-style-guide), the official Swift [API Design Guidelines](https://swift.org/documentation/api-design-guidelines/).
27+
28+
Please also make sure that relevant code is documented and tested. :page_with_curl:
29+
30+
More information on how to create a pull request can be found in [this tutorial](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). :mortar_board:
31+
32+
GitHub also has a nice blog post on [how to create the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request). :sparkles:

CONTRIBUTING.md

-11
This file was deleted.

0 commit comments

Comments
 (0)