nocebo/diaspora_federation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Overhaul README, add contributing notes.

Browse source
This commit is contained in:
Dennis Schubert 2016-06-26 03:37:48 +02:00
parent 8c91d2a1f7
commit 87fcfca6af
2 changed files with 35 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,26 @@
# Contributing to our federation
First of all: thank you very much for helping us out! Since the federation layer is a very crucial part of diaspora\*, contributing has some rules, depending on what you want to contribute.
## Things you need to know before contributing
If you want to get in touch with other diaspora\* developers, [check our wiki][how-we-communicate] for information on how we communicate. Feel free to ask if you have any questions!
As with the main diaspora\* repository, everyone interacting with our code, issue trackers, chat rooms, mailing lists, the wiki, and the Loomio group is expected to follow the [diaspora\* code of conduct][code-of-conduct].
## Report a security issue
Found a security issue in some parts of the protocol or its implementation? Please disclose it responsibly. We have a team of developers listening to [security@diasporafoundation.org][sec-mail]. The PGP fingerprint is [AB0D AB02 0FC5 D398 03AB 3CE1 6F70 243F 27AD 886A][pgp].
## Improve the documentation
Feel free to open a pull request right away if you would like to improve the inlined code documentation or the dedicated federation protocol documentation.
## Changing implementations or altering fields
If you want to change implementations of existing functions or you would like to suggest a change in the federation protocol, please open an issue *before doing anything else*. Try to describe you idea and why you think the implementation or the protocol should change as close as possible. Most changes will have to get discussed in a larger group before implementing them, so it's important to start those discussions before writing any code.
[code-of-conduct]: https://github.com/diaspora/diaspora/blob/develop/CODE_OF_CONDUCT.md
[how-we-communicate]: https://wiki.diasporafoundation.org/How_we_communicate
[pgp]: https://pgp.mit.edu/pks/lookup?op=get&search=0x6F70243F27AD886A
[sec-mail]: mailto:security@diasporafoundation.org

35
README.md
View file

@ -1,8 +1,7 @@
# diaspora* federation library # diaspora* federation library
### A library that provides functionalities needed for the diaspora\* federation protocol
**A library that provides functionalities needed for the diaspora* federation protocol** **master:** [![Build Status master](https://travis-ci.org/diaspora/diaspora_federation.svg?branch=master)](https://travis-ci.org/diaspora/diaspora_federation) |
**master:** [![Build Status master](https://travis-ci.org/diaspora/diaspora_federation.svg?branch=master)](https://travis-ci.org/diaspora/diaspora_federation)
**develop:** [![Build Status develop](https://travis-ci.org/diaspora/diaspora_federation.svg?branch=develop)](https://travis-ci.org/diaspora/diaspora_federation) **develop:** [![Build Status develop](https://travis-ci.org/diaspora/diaspora_federation.svg?branch=develop)](https://travis-ci.org/diaspora/diaspora_federation)
[![Code Climate](https://codeclimate.com/github/diaspora/diaspora_federation/badges/gpa.svg)](https://codeclimate.com/github/diaspora/diaspora_federation) [![Code Climate](https://codeclimate.com/github/diaspora/diaspora_federation/badges/gpa.svg)](https://codeclimate.com/github/diaspora/diaspora_federation)
@ -14,16 +13,12 @@
[Documentation](http://www.rubydoc.info/gems/diaspora_federation/) | [Documentation](http://www.rubydoc.info/gems/diaspora_federation/) |
[Bugtracker](https://github.com/diaspora/diaspora_federation/issues) [Bugtracker](https://github.com/diaspora/diaspora_federation/issues)
## Library This repository contains two gems:
The ```diaspora_federation``` gem provides the functionality for de-/serialization and de-/encryption of Entities * `diaspora_federation` provides the functionality for de-/serialization and de-/encryption of Entities in the protocols used for communication among the various installations of diaspora\*.
in the protocols used for communication among the various installations of Diaspora* * `diaspora_federation-rails` is a rails engine that adds the diaspora\* federation protocol to a rails app.
## Rails Engine ## Usage
The ```diaspora_federation-rails``` gem is a rails engine that adds the diaspora* federation protocol to a rails app.
### Usage
Add the gem to your ```Gemfile```: Add the gem to your ```Gemfile```:
@ -61,22 +56,10 @@ DiasporaFederation.configure do |config|
end end
``` ```
## Development ## Contributing
**!!! This gem is currently under heavy development, so every release can contain breaking changes !!!** See [our contribution guide](/CONTRIBUTING.md) for more information on how to contribute to the diaspora\* federation library.
If you want to help, please contact me, help is welcome.
After the first stable release, this repo will be moved to the [diaspora organization](https://github.com/diaspora/).
## Diaspora
A privacy-aware, distributed, open source social network
Links:
[Project site](https://diasporafoundation.org) |
[Wiki](https://wiki.diasporafoundation.org)
## License ## License
This gem is published under the terms of the "GNU Affero General Public License". See the LICENSE file for the exact wording. [GNU Affero General Public License](/LICENSE).