Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Updated documentation #234

Closed
wants to merge 2 commits into
from
Jump to file or symbol
Failed to load files and symbols.
+78 −56
Split
View
@@ -19,10 +19,9 @@ Contents:
:maxdepth: 2
installation
+ workflow
settings
- registration
invites
- search
Indices and tables
------------------
View
@@ -49,6 +49,12 @@ you:
$ ./manage.py syncdb --noinput
$ ./manage.py migrate
+ .. note::
+ Some people have run into issues with existing south migrations that
+ have note run. To remedy this run ``mysql -u root`` to get into the mysql
+ shell. From there run ``drop database mozillians;`` and ``create database mozillians;``
+ and quit with ``\q``. Run the ``syncdb`` and ``migrate`` commands as above again.
+
6. Run the development web server (in the virtualized environment)::
$ ./manage.py runserver 0.0.0.0:8000
View
@@ -1,43 +0,0 @@
-.. _registration:
-
-============
-Registration
-============
-
-Registration happens at ``/register``. Data is taken from a form and if it
-passes validation it will be submitted.
-
-Fields
-------
-We are collecting the following fields:
-
-* First Name
-* Last Name
-* Display Name
-* IRC nickname
-* Bio
-* Photo
-* Email Address
-* Password
-
-Photos
-------
-
-Photos are transformed into JPEG for storage in the LDAP directory.
-
-Validation
-----------
-
-We'll try to use as little validation as possible. First and Last names should
-be as flexible as possible to support all variety names:
-
-* Bob Saget
-* Madonna
-* @ Johnson
-* Dr. 8
-* 49
-* Jane Doe Smith
-
-Are all perfectly valid names that we must support.
-
-Email address, however can be validated. As can IRC nickname.
View
@@ -1,11 +0,0 @@
-.. _search:
-
-======
-Search
-======
-
-Pagination Notes
-----------------
-
-The pagination functionality currently requires the database to load the
-entire collection into memory before generating the offsets.
View
@@ -0,0 +1,71 @@
+.. _workflow:
+
+============
+Workflow
+============
+
+.. note::
+ The Mozillians workflow might be daunting. Ask for help in #mozillians on
+ irc.mozilla.org. jsocol, timw, or tallOwen will be happy to help.
+
+This is our basic workflow for how features are born. It is what you need to
+do to get code landed.
+
+1. Start a new feature branch::
+
+ Figure out what you want to work on by asking in IRC, finding an open bug in
+ Bugzilla or find something small (CSS fix, or typo) that bothers you in the
+ site and fix it.
+
+ ::
+
+ $ git checkout -b {{ new branch name }}
+
+ .. seealso::
+ `The git book: git branching
+ <http://book.git-scm.com/3_basic_branching_and_merging.html>`_
+
+2. Work on said feature and run tests::
+
+ $ t
+
+ or without vagrant:
@jsocol

jsocol May 25, 2012

Member

Need a double-colon to turn the next line into a code block.

+
+ ::
+
+ $ ./manage.py test -x --logging-clear-handlers --with-nicedots'
+
+ .. note::
+ You may run into issues with the database if you have added south migrations
+ or if your database is out of sync. You can run ``td`` or
+ ``FORCE_DB=True ./manage.py test -x --logging-clear-handlers --with-nicedots --noinput`` if you are having issues.
@jsocol

jsocol May 25, 2012

Member

Wrap this line. You might just want to make the literal a code block like the previous two.

@tallowen

tallowen May 25, 2012

Member

Can you do that inside the note block?

+
+ If all the tests pass you are good to go! If you are working on a feature
+ or a regression we will ask that you add your own tests. (Look for a test
+ directory or a tests.py file in any of the apps.)
+
+3. Commit your changes::
+
+ We ask that your commit message reference a bug that it is fixing, a good
+ subject line and a summary of what has changed in the body of the commit.
@jsocol

jsocol May 25, 2012

Member

commit.

+
+ .. seealso::
+ `A note about git commit messages
+ <http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_
+
+4. Submit a pull request::
+
+ To get your code into the code base you will need to get it reviewed by one
+ of the core devs. Submit a pull request on GitHub and ask for a review in
+ the #mozillians or #commtools chanel.
+
+ After a review, you may need to make changes to your code. If you are
+ confused by the comments on your code ask the reviewer what they mean and
+ they will gladly answer questions.
+
+ .. seealso::
+ `GitHub: Sending pull requests
+ <http://help.github.com/send-pull-requests/>`_
+
+
+