search

Ex-Mente / auxi.0

GNU Lesser General Public License v3.0
8 stars 8 forks source link

Add system documentation #33

Closed christoffkok closed 8 years ago

christoffkok commented 8 years ago

Background

auxi is a an open source project, and we are finding increasingly that persons outside of Ex Mente want to contribute. Such contributions will only be feasible if a well-defined method of contributions and maintenance is available. It is also important that everyone involved in the auxi initiative is aware of how the system is developed, maintained and released, to avoid uncertainty and to enhance the rate at which auxi can progress and the quality of the tools that are delivered.

It is therefore required that we develop a concise set of system documents that explain the most important concepts, and how the different workflows function.

Purpose

The purpose of this issue is to develop a set of system documents to support all auxi role players in contributing, bug fixing, releasing and other relevant aspects required to develop, maintain and enhance auxi.

Approach

The documentation will be hosted on GitHub as markdown (.md) files. It will be modular, with one important component addressed per document.

Scope

The following items must be created/updated in the system documentation.

README.md

Explain the different roles in auxi development. This is currently maintainer and contributor.

STANDARDS.md

Identify and explain the project's standards regarding coding, documentation, issues, tests, etc. that need to be enforced and adhered to to ensure that auxi remains a high quality, productivity enhancing package.

CONTRIBUTING.md

Explain the following:

Explain the details of how releases are done. This is for maintainers only, but everyone should be informed about how this works.

RELEASE-NOTES.md

Create a properly formatted file that can be used to capture the details of each release.

christoffkok commented 8 years ago

Coding Styles: Following PEP 8 standards http://stackoverflow.com/questions/1523427/what-is-the-common-header-format-of-python-files

Add to documentation a description of Travis.CI, Waffle, and that Travis will be used to check coding standards, test passes, and test coverage.

christoffkok commented 8 years ago

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.