Skip to content

developing

Jump to bottom
Graham Lopez edited this page Jun 10, 2019 · 8 revisions

These are some pages to help developers get familiar with the workflow that is used in the ASGarD project; anyone who intends to contribute code to ASGarD is assumed to be familiar with the pages in this section of the wiki.

Structural Overview of ASGarD

A short explanation of the layout of the ASGarD C++ code repository and how the code is generally structured.

More details about the code

Contributing code

This page is for developers who wish to contribute code to the main ASGarD codebase. It explains our process and expectations.

Making tests for your code

We require that all C++ code is unit tested, so here are some hints and guidelines about how to contribute tests along with your code.

ASGarD project coding standards and conventions

A quick summary of our coding standards and references to general materials about C++ and development best practices.

Code reviews checklist

All code in the ASGarD undergoes peer review. This summarizes the process and contains a checklist of things that reviewers should be looking for.

A page for maintainers

How to handle pull requests, make versioned releases, etc.

Using Issues

For developers, when using issues remember to:

  • label all issues; try to use existing label(s) to avoid over-proliferation
  • reference issues in PR comments and git commits, and vice versa
    • "This [PR|commit] attempts to address the problem described in #36"
    • "This issue is closed by the fix in PR !103"
    • "That is some dodgy code in cb5cfe97"

Miscellaneous

Clone this wiki locally