Skip to content

Home

Jump to bottom Edit New page
Levi Starrett edited this page Mar 14, 2020 · 11 revisions
Ciera

Welcome to the Ciera project!

Contribution Guidelines

If you would like to contribute to either the documentation (wiki) or the source repository, please follow these guidelines.

Create an issue

Always start by creating an inssue in the Issue Tracker. Be sure to include details about what the expected and observed behavior is (in the case of a bug), and if possible attach a reproduction case or give detailed instructions on how to reproduce. If the issue is a feature, describe exactly what the proposed requirements are.

Implementation

During implementation of a feature or bug fix, make all commits in a branch in your fork of the repository. Each commit message should begin with job #<issue_number> so that all changes can be tracked.

Documentation/Review

For small bug fixes, conversation in the issue tracker is sufficient. However, for more extensive changes and features, an engineering not should be created.

To create a note in the wiki:

  • Click "New Page".

  • Give your page name a title "<issue_number>_<title>".

  • Select "AsciiDoc" for edit mode (AsciiDoc quick reference).

  • Copy the note template from here into the content box.

  • Fill out the template with relevant information.

  • In the edit message box add a commit message (e.g. "job #9999 added note for feature A"), and click "Save Page"

  • Navigate to the "Engineering Documentation" wiki page (see sidebare or click here)

  • Edit this page by clicking "Edit". Add a line for your newly created note and commit. Be sure to keep the notes numerically ordered by issue number.

Submitting a pull request

When your feature and documentation are complete, submit a pull request to the Ciera source repository. Be sure to include a link to the issue and the engineering note in the pull request. From there a committer will work with you to review and merge the change into master.

Contributing to the user guide

To contribute to the user guide, simply edit pages in this wiki. Please tag all changes with a corresponding issue in your commit message. Discussion of changes to the user guide should occur in the issue before any changes are made.

How to build and distribute the user guide

  1. Clone the repository.

    git clone https://github.com/xtuml/ciera.wiki
cd ciera.wiki

  2. Make sure the version is up to date. Edit line 3 of Guide.asciidoc, the version in pom.xml and find and replace all references to the latest version ID in the guide itself.

  3. Build the PDF user guide

    mvn clean process-resources

  4. Copy the user guide to the userguide/en_US directory of the cieradoc repository. Commit and push.

    cp target/generated-docs/CieraUserGuide.pdf ~/git/cieradoc/userguide/en_US
Add a custom footer
Contents

Home
User Guide

Clone this wiki locally