Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.5 KB
Raw

Contributing to Tutorials

By contributing to Tutorials, you accept and agree to the following Developer Certificate of Origin Version 1.1 (see below) for all your contributions.

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


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.

How to contribute

Introduction

This repository contains the sources to automatically create a tutorial driven documentation for Gridap project.

You can visit the latest stable version of this documentation here.

Please, read this document as a starting point before a contribution.

Automatic generation

Tutorials web page is automatically generated by using Literate.jl package.

Please, follow their rules and conventions to alternate comments and source code.

Add a new tutorial

  1. Add a new Julia script to src directory.
  2. Add a new (Title,filename) pair to files array in deps/build.jl file.

Tutorial headers will be auto generated using the specified Title.