@@ -9,7 +9,10 @@ Welcome to Annot's documentation!
Annot is a web application to annotate bioscience experiments, to capture the experiments metadata and data so that data are ready for analysis and sharing.
Annot is utterly modularly implemented to be adaptable to each laboratories specific needs.
Annot is written in Python 3 with Django.
The source code is distributed under the free and open source AGPLv3 license.
The source code is distributed under the free and open source GNU AGPLv3 license, while this documentation is under the free and open source GNU FDLv1.3 license.
.. dont froget readme.rst file with version log! readme.rst shoul link to readthedocs.org
* Don't forget to add, commit, and push your changes to your git repository. And if your code runs, don't forget to merge request that the changes can be forked back into the official repository.
Style Guide
-----------
Sotware Philosphy and Style Guide
----------------------------------
This is section is about coding stile and philosopy.
If you like to contribute the project please stick to thissoftware philosophy guide.
If you like to learn about pilosopy and concept of the Annot project in the big picture pleas read the introcdction chapture.
Pep8 ?
^^^^^^
.. Not really.Naturaly over the years of codeing one will definitely develop his one stille. For the moment I like to value that. I think one can lern from others style. Though this might chnage in the future. I will see how it will work out not explicitely to enforce pep8 for the project.
.. You can learn from the otherones style.
.. Can I addapt the pep8 tool that it only checks what I want?
.. Comment your code
.. The variable nameing convention is most important to me.
Brackets, Chars and Strings
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. Personally I like brackets. They make things clear. I like to introduce
Variable and Constant Nameingconvention
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. hungarian notation
Functions and Classes
^^^^^^^^^^^^^^^^^^^^^
.. docstring! spell checked.
Django App Nameingconvention
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. appon
.. appsa
.. appas_
Code Example: Implement a New Assay Workflow
---------------------------------------------
.. expectation somehow familiar with Python 3 and Django
You would like contribute the the project? Great! Be welcome.
The following lines should get your ready.
Code
^^^^
.. Forking, Codeing, Pull Request
.. Unity Testing (opey the testing goat)
.. Pep8? Check out this projecyts phylosphy and style guide.
.. don't forget you sellf to add you to the authorlist
Documentation
^^^^^^^^^^^^^
.. spellchecking
.. no trailing whitespaces
.. don't forget you sellf to add you to the authorlist
Author List
-----------
In alphabetic order:
Amanda Esch: wetlab knowledge antibody
Carly King: documentation work
Elmar Bucher (bue): main programmer
Joe Gray: principal investigator
Jim Korkola: wetlab knowledge MEMA assay
Laura Heiser: principal investigator
Mark Dane: concept input
Rebekka Smith: wetlab knowledge protein and compounds
Wally Thompson: wetlab knowledge protein and compounds
Who is Author?
^^^^^^^^^^^^^^
It does not matther if you contributes to the project by code or documentation, when your foke is ready to be merged with the official master branch add your self to the author list! There are as well a view author that have not contibutd by code or documentation, but by conceptual input an biological field knowledge which was important to the project.
