Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
AO-StreetArt committed Jul 3, 2017
1 parent 70d8601 commit 08b8ba4
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 17 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
We love pull requests from everyone. By participating in this project, you agree to abide by the Code of Conduct, specified in the CODE_OF_CONDUCT.md file.

Start by forking and cloning the repository, then following the instructions to [build from source](http://aosharedservicelibrary.readthedocs.io/en/latest/quickstart.html).

Ensure that the tests pass:

`make && make test`

Make your changes and write tests for your changes, then ensure that all tests pass:

`make clean && make && make test`

Push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

* Write tests
* Comment your code
* Write a good commit message
* If you have many different commits, use rebase to consolidate down to a single commit
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,18 @@ While designed with a Microservice architecture in mind, AOSSL also seeks to mai
## Documentation
Check out online documentation of the latest version at [ReadTheDocs](http://aosharedservicelibrary.readthedocs.io/en/latest/index.html).

Stuck and need help? Have general questions about the library? Reach out to the development team at aossl@emaillist.io

## Contributing

All contributors are welcome, including (but not limited to) pull requests, issues, documentation, examples, and feature requests. Please see the Code of Conduct file for an overview on the expectations for all contributors.
All contributors are welcome, including (but not limited to) pull requests, issues, documentation, examples, and feature requests. Please see the Code of Conduct and the contributing files for an overview on the expectations for all contributors.

Contributors should also review the documentation carefully, in particular the [Developer Notes](http://aosharedservicelibrary.readthedocs.io/en/latest/dev_notes.html) section.

We are actively looking for anyone interested in joining the development team. If you are interested, please send an email to aostreetart9@gmail.com.
We are actively looking for anyone interested in working on the following areas:

There are a number of topics which have been identified as areas needing development, and contributors are encouraged to work on these areas as well.
* Security
* Thread-Safety
* Code Optimization

* Sentinel & Cluster support for Redis Drivers
* Benchmarks for Mongo & Neo4j
* ZeroMQ encryption
* Library testing with OSX and/or other Linux Distributions not already supported
* CMake Support
If you are interested, or are interested in joining the development team in general, please send an email to aossl@emaillist.io
9 changes: 0 additions & 9 deletions docs/README.md

This file was deleted.

8 changes: 8 additions & 0 deletions docs/pages/dev_notes.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/*! \page dev_notes Developer Notes
*
* # Developer Notes
*
* This page contains a series of notes intended to be beneficial for any contributors to AOSSL.
*
* \ref index "Go Home"
*/

0 comments on commit 08b8ba4

Please sign in to comment.