Permalink
Browse files

update changelog

  • Loading branch information...
iandennismiller committed Nov 24, 2017
1 parent 066af46 commit a718f220e0ceba7e67fd1259ee7b795a6904cec8
Showing with 84 additions and 35 deletions.
  1. +2 −3 Readme.rst
  2. +2 −2 docs/Todo.md
  3. +31 −11 docs/changelog.rst
  4. +16 −16 docs/community/contributing.rst
  5. +30 −0 docs/community/developer.rst
  6. +3 −3 docs/index.rst
@@ -41,12 +41,11 @@ Install Windows
^^^^^^^^^^^^^^^

Ensure you have the `System Requirements <http://docs.gthnk.com/en/latest/intro/system-requirements.html>`_ installed: Python 3.6, ``virtualenv``, ``virtualenvwrapper``, and ``virtualenvwrapper-win``.
Once the requirements are installed, launch `cmd.exe` and run the following:
Once the requirements are installed, launch ``cmd.exe`` and run the following:

::

mkvirtualenv gthnk
workon gthnk
easy_install -U mr.bob==0.1.2
pip install gthnk
python %virtual_env%\Scripts\integration.py install
@@ -61,9 +60,9 @@ Once the requirements are installed, launch ``terminal.app`` and run the followi
::

mkvirtualenv gthnk
workon gthnk
pip install gthnk
integration.py install
gthnk

Documentation
^^^^^^^^^^^^^
@@ -4,8 +4,6 @@

Communication with prospective users.

- [ ] fill out changelog
- [ ] write contributing document
- [ ] powerpoint presentation
- [ ] produce overview video
- [ ] release rc2
@@ -56,3 +54,5 @@ Integration and exchange of information.
- [x] riot/matrix channel
- [N] longer timeout for website authentication
- [x] separate static content from template content
- [x] fill out changelog
- [x] write contributing document
@@ -4,9 +4,7 @@ Changelog
0.5.0
-----

- 2017-11-XX
- ...

2017-11-XX

- integration subsystem for Windows and OS X
- python 3 compatibility
@@ -15,27 +13,49 @@ Changelog
- code coverage
- bug: fix date picker
- bug: image attachments not centering
- updated to Flask-Diamond 0.5.0

0.4.0
-----

- 2016-01-05
- 20f71c7a773c2321b52b421b831d039ef23d6d01
2016-01-05

- revise documentation
- clean unnecessary dependencies
- automated install process on OS X
- major refactor of code
- updated to Flask-Diamond 0.2.14

0.3.0
-----

- 2015-01-31
- 70efeefdfb4d5e54bb8713d94301375b68db8c08
2015-01-31

- revised user interface
- image and PDF attachments
- PDF export
- calendar date navigation
- robust filesystem export

0.2.0
-----

- 2014-11-15
- b8793334ccd918a3ca5f0739ca668527e08de1b4
2014-11-15

- new architecture with app server and database
- revised user interface
- search results link to day
- migrating last parts of old "greenthink" project
- better project distribution with Makefiles

0.1.0
-----

- 2013-12-09
- 90fd96647ca24d568d16779420029c8fbb2d41b6
2013-12-09

- renaming "greenthink" as Gthnk
- feature: review yesterday's notes
- markdown in entries
- project review subsystem
- OS X service launches review every day
- support mobile; import multiple text sources
@@ -2,14 +2,15 @@ Contributing
============

Gthnk welcomes contributions from the community.
The most important theme Gthnk needs help with is *communication*.
The most important theme for Gthnk contributions is *communication*.
An open source project thrives when communication is healthy.

Here are examples of some ways you can help:

- Help field questions from the community
- Extend and clarify the documentation
- Implement your favorite feature
- Fix a bug in the code
- improve code quality, coverage, and comments
- Internationalization; help with translations
- Software Development

Help field questions from the community
---------------------------------------
@@ -19,23 +20,22 @@ Fantastic!
Please join our chatroom at http://chat.gthnk.com and just hang out to help answer questions from the community.
People will occasionally come by to ask questions and you can help immensely by answering some of them.

Implement your favorite feature
-------------------------------

If you know a feature you'd like to code in order to help with Gthnk, then the easiest way to help is by submitting a `pull request <https://help.github.com/articles/creating-a-pull-request/>`_ to Gthnk on GitHub.
From your perspective, there is no barrier preventing you from contributing to Gthnk today.

Help with the documentation
---------------------------

Project documentation is one of the most important aspects of an open source project.
You can help immensely by editing the current documentation for clarity.
You can find the documentation in the `Gthnk repository <https://github.com/iandennismiller/gthnk/>`_, which you can modify by submitting a pull request.

Help with an existing issue
---------------------------
Internationalization
--------------------

Can you help localize Gthnk for a new language?
We can use help translating the software, websites, and documentation.
If you want to help make Gthnk available to a new community of users, please find us in the `chat room <http://chat.gthnk.com>`_.

Software Development
--------------------

Another way you can contribute is by working directly upon issues that have been submitted by the community using the `Issue Tracker <http://issues.gthnk.com>`_.
This is more advanced than simply implementing a new feature, because the issue may specify acceptance criteria.
It is recommended that you coordinate with project members before working on an issue.
The easiest way to contact the team is through the `Issue Tracker <http://issues.gthnk.com>`_ itself, because each issue has a comment thread associated with it.
Gthnk is an open source project.
If you know Python, please see the :doc:`developer` document for more information.
@@ -0,0 +1,30 @@
Developer
=========

The first step is to clone the `project repository <http://github.com/iandennismiller/gthnk>`_ using git.
Then, give the rest of this document a read for some specific ideas about contributing.

Submitting a pull request
-------------------------

Gthnk development occurs in the `develop` branch of the git project.
We welcome thoughtful pull requests against the `develop` branch with code that includes comments and tests.
When you create a `pull request <https://help.github.com/articles/creating-a-pull-request/>`_, be sure you have the latest version of the `develop` branch.

Implement your favorite feature
-------------------------------

If you know a feature you'd like to code in order to help with Gthnk, then make your own local branch and write it until you are happy.
Depending on the scope of the feature, you might want to get in touch via the `chat room <http://chat.gthnk.com>`_ to brainstorm, first.

If you end up writing a feature that is really useful to you, then maybe you will consider contributing it to the community.
In that case, be sure to write tests for your feature and add code comments where appropriate.
The code should pass a Python linter that checks for PEP8 compliance.

Help with an existing issue
---------------------------

You can contribute by working on issues that have been submitted by the community using the `Issue Tracker <http://issues.gthnk.com>`_.
This is a little more advanced than simply implementing a new feature since the issue may imply acceptance criteria.
It is recommended that you coordinate with project members before working on an issue.
The easiest way to contact the team is through the `Issue Tracker <http://issues.gthnk.com>`_ itself; each issue has a comment thread associated with it.
@@ -32,9 +32,9 @@ Community
.. toctree::
:maxdepth: 1

contributing/contributing
contributing/developer
contributing/release
community/contributing
community/developer
community/release

About
-----

0 comments on commit a718f22

Please sign in to comment.