Init README and howto contribute

2018-11-29 11:49:57 +08:00 · 2018-11-29 11:49:57 +08:00 · ab4ee25d49
commit ab4ee25d49
2 changed files with 58 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,10 @@
+ Awesome Secure Messaging
+*A curated collection of links for secure messaging. Part of the ["Awesome X" series](https://github.com/sindresorhus/awesome).*
+
+## Table of Contents
+
+- [Fundamentals](#fundamentals)
+
+## Fundamentals
+
+- [SoK: Secure Messaging](http://cacr.uwaterloo.ca/techreports/2015/cacr2015-02.pdf) - evaluation of current secure messaging solutions based on security, usability and adoption
--- a/contributing.md
+++ b/contributing.md
@ -0,0 +1,48 @@
+# Contribution Guidelines
+
+## Table of Contents
+
+- [Adding to this list](#adding-to-this-list)
+- [Adding something to an awesome list](#adding-something-to-an-awesome-list)
+- [Updating your Pull Request](#updating-your-pull-request)
+
+## Adding to this list
+
+First, thank you for your suggestions!
+
+Please ensure your pull request adheres to the following guidelines:
+
+- Search previous suggestions before making a new one, as yours may be a duplicate.
+- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description.
+- Make an individual pull request for each suggestion.
+- Use [title-casing](http://titlecapitalization.com) (AP style).
+- Use the following format: `[List Name](link) - Description.`
+- Link additions should be added to the bottom of the relevant category.
+- New categories or improvements to the existing categorization are welcome.
+- Check your spelling and grammar.
+- Make sure your text editor is set to remove trailing whitespace.
+- The pull request and commit should have a useful title.
+- The body of your commit message should contain a link to the repository.
+
+Then append your suggestion to the list of "Links Sent by Readers" section. Once in a while, I review this list and move links to other categories.
+
+See you there!
+
+## Adding something to an awesome list
+
+If you have something awesome to contribute to an awesome list, this is how you do it.
+
+You'll need a [GitHub account](https://github.com/join)!
+
+1. Access the awesome list's GitHub page: https://github.com/status-im/awesome-secure-messaging
+2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
+3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png)
+4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png)
+5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png)
+6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
+
+## Updating your Pull Request
+
+Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.
+
+[Here](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.