Skip to content

Commit 5aa313e

Browse files
committed
Add ToC to contributing.md
1 parent 85fa038 commit 5aa313e

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,22 @@
22

33
Looking to contribute something to [json-fortran](README.md)? **Here's how you can help.**
44

5+
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
6+
**Table of Contents**
7+
8+
- [Key Branches](#key-branches)
9+
- [Filing issues](#filing-issues)
10+
- [Outstanding Work](#outstanding-work)
11+
- [Pull Requests](#pull-requests)
12+
- [Coding Standards](#coding-standards)
13+
14+
<!-- markdown-toc end -->
15+
516
## Key Branches
617

718
- `master` is the latest, development version and all efforts should be made to keep it stable.
819

20+
[top](#contributing-to-json-fortran)
921
## Filing issues
1022

1123
- Before filing a new [issue](https://github.com/jacobwilliams/json-fortran/issues), please perform a search to see if that issue has already been filed by someone else, and whether or not a solution exists. If you are experiencing the same issue as one that's already posted, please leave any additional comments and information under the existing issue. If your issue is related to a previous issue, but substantively different, file a new issue and include a mention of the related issue in text, using GitHub's `#<issue-number>` syntax.
@@ -16,10 +28,12 @@ Looking to contribute something to [json-fortran](README.md)? **Here's how you c
1628
1. If applicable, what compiler you used, and any non-standard options or configurations that were used.
1729
1. All steps required to reproduce the problem
1830

31+
[top](#contributing-to-json-fortran)
1932
## Outstanding Work
2033

2134
- Take a look at the [issues](https://github.com/jacobwilliams/json-fortran/issues) to see if there is an issue you'd like to help address. [Issues](https://github.com/jacobwilliams/json-fortran/issues) with the [ready label](https://github.com/jacobwilliams/json-fortran/issues?q=is%3Aopen+is%3Aissue+label%3A%22ready%22) or in the [ready column on waffle.io](https://waffle.io/jacobwilliams/json-fortran) are issues that are ready to be dealt with. (i.e., They are not blocked by other dependencies and are higher priority.)
2235

36+
[top](#contributing-to-json-fortran)
2337
## Pull Requests
2438

2539
- Try not to pollute your pull request with unintended changes--keep them simple and small
@@ -38,6 +52,7 @@ git rebase upstream
3852
- Pull requests are tested by our [travis-ci](https://travis-ci.org/jacobwilliams/json-fortran) continuous integration system, and any errors uncovered will need to be fixed before the pull request can be merged into master.
3953
- The json-fortran library and associated documentation is released under a BSD style [license](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE). By submitting a pull request, you are agreeing to release your code under the same license. Note that code with GPL or other "copyleft" style licenses will not be accepted.
4054

55+
[top](#contributing-to-json-fortran)
4156
## Coding Standards
4257

4358
- Each commit should address a single logical change and code base transformation.
@@ -48,4 +63,6 @@ git rebase upstream
4863
- *Do NOT* allow your editor to make a bunch of indentation or white space changes, that will introduce non-substantive changes on lines that you have not actually edited.
4964
- The coding style is modern free-form Fortran, consistent with the Fortran 2008 standard. Note that the two supported compilers (ifort and gfortran) do not currently include the entire Fortran 2008 standard. Therefore, only those language features supported by Gfortran 4.9 and Intel 13.1.0 are currently allowed. This also means that previous versions of these compilers are not supported, and major changes to the code to support earlier compilers (or Fortran 95) will not be accepted. At some point in the future (when compiler support has improved), all Fortran 2008 features will be allowed.
5065
- All subroutines and functions *must* be properly documented. This includes useful inline comments as well as comment blocks using the [ROBODoc](http://rfsber.home.xs4all.nl/Robo/manual.html) syntax.
51-
- For simplicity, json-fortran currently consists of one module file. It is not envisioned that it will ever need to expand to include multiple files (if it does, there would need to be a very good reason).
66+
- For simplicity, json-fortran currently consists of one module file. It is not envisioned that it will ever need to expand to include multiple files (if it does, there would need to be a very good reason).
67+
68+
[top](#contributing-to-json-fortran)

0 commit comments

Comments
 (0)