You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contributing to [json-fortran](README.md)
1
+
# Contributing to JSON-Fortran
2
2
3
-
Looking to contribute something to [json-fortran](https://github.com/jacobwilliams/json-fortran)? **Here's how you can help.**
3
+
Looking to contribute something to [JSON-Fortran](https://github.com/jacobwilliams/json-fortran)? **Here's how you can help.**
4
4
5
5
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
6
6
**Table of Contents**
@@ -20,7 +20,7 @@ Looking to contribute something to [json-fortran](https://github.com/jacobwillia
20
20
[top](#contributing-to-json-fortran)
21
21
## Filing issues
22
22
23
-
- 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.
23
+
- 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 Jib's `#<issue-number>` syntax.
24
24
- When filing an issue please try to include all of the following information
25
25
1. Problem description: What behavior are you seeing that you think is erroneous
26
26
1. Installation method: Did you build the code with one of the included build scripts? Some other way? Install from a binary package?
@@ -53,7 +53,7 @@ Looking to contribute something to [json-fortran](https://github.com/jacobwillia
53
53
- Pull requests should address one issue at a time, and each commit should be a set of self contained, related changes. If you forget something in a commit, please use `git rebase -i <ref>^` to amend and/or squash erroneous commits. Here `<ref>` is the reference to to oldest commit needing to be modified (SHA, or `HEAD~4`, etc.)
54
54
- Each commit should compile, and ideally pass the tests. Very complicated new features or fixes, may have commits that don't pass tests, if otherwise the commit history would include far to many changes in any given commit. Use an interactive rebase to fix any of these issues, as described above.
55
55
- Each commit should have a concise, descriptive message following the
- Create a branch in your fork with a descriptive name that also includes the [issue number](https://github.com/jacobwilliams/json-fortran/issues), if applicable. For example, after forking the repo, you can run something like `git checkout -b Unicode-support-issue-35` before starting work on [issue #35 : Unicode support](https://github.com/jacobwilliams/json-fortran/issues/35)
74
74
- When you're content with your changes, your commits are clean, self contained, with concise descriptive messages, and your changes compile and pass the tests, submit a pull request. We will review your changes, and may ask for certain modifications to be made.
75
75
- 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.
76
-
- 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.
76
+
- 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.
77
77
78
78
[top](#contributing-to-json-fortran)
79
79
## Coding Standards
@@ -87,7 +87,7 @@ git rebase upstream/master
87
87
- New tests are added to the `src/tests` directory and are named
88
88
`jf_test_<#>.[Ff]90`. Each test is a stand alone Fortran program
89
89
which will automatically be compiled and linked against the
90
-
json-fortran library so long as it follows this naming
90
+
JSON-Fortran library so long as it follows this naming
91
91
convention. If any of the tests fail, the test program should exit
92
92
with a non-zero return status, using the `stop 2` intrinsic
93
93
statement. (The Fortran standard does not require the 'processor' to
@@ -99,6 +99,6 @@ git rebase upstream/master
99
99
-*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.
100
100
- 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.
101
101
- All subroutines and functions *must* be properly documented. This includes useful inline comments as well as comment blocks using the [FORD](https://github.com/cmacmackin/ford/wiki/Writing-Documentation) syntax.
102
-
- 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).
102
+
- 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).
0 commit comments