Skip to content

Latest commit

 

History

History
102 lines (68 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

102 lines (68 loc) · 3.09 KB

Contributing to Ariadne

When contributing to the development of Ariadne, please first discuss the change you wish to make via issue, email, or any other method with the maintainers before making a change.

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

Table of contents

  1. Creating an issue
  2. Template
  3. Example of a good issue
  4. Pull requests

Issues, issues and more issues!

There are many ways you can contribute to Ariadne, and all of them involve creating issues in Ariadne issue tracker. This is the entry point for your contribution.

To create an effective and high quality ticket, try to put the following information on your ticket:

  1. A detailed description of the issue or feature request
    • For issues, please add the necessary steps to reproduce the issue.
    • For feature requests, add a detailed description of your proposal.
  2. A checklist of Development tasks
  3. A checklist of Design tasks
  4. A checklist of QA tasks

Issue template

[Title of the issue or feature request]

Detailed description of the issue. Put as much information as you can, potentially
with images showing the issue or mockups of the proposed feature.

If it's an issue, add the steps to reproduce like this:

Steps to reproduce:

1. Run Ariadne
2. Load a FE model
3. ...

## Design Tasks

* [ ]  design tasks

## Development Tasks

* [ ]  development tasks

## QA Tasks

* [ ]  qa (quality assurance) tasks

This is an example of a good and informative issue:

Example: Multivariate optimization method should be more robust

Using the coordinate descent method currently leads to an unstable solution, because there are functions that do not even lead to a local optimum. This is not good for high order elements, as the solution will only converge in some cases.

It is proposed to use a more complex but more robust Nelder-Mead method.

Design Tasks

  • Define how best to implement the Nelder-Mead method

Development Tasks

  • Implement Nelder-Mead method

QA Tasks

  • Check method convergence
  • Check method stability

Pull Request Process

  1. Ensure your code compiles. Build project before creating the pull request.
  2. If you're adding new external API, it must be properly documented.
  3. The commit message is formatted as follows:
   component: <summary>

   A paragraph explaining the problem and its context.

   Another one explaining how you solved that.

   <link to the bug ticket>
  1. You may merge the pull request in once you have the sign-off of the maintainers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.