Skip to content

Commit

Permalink
DOC: consistency via markdownlint; move AUTHORS to AUTHORS.md (#4096)
Browse files Browse the repository at this point in the history
  • Loading branch information
mwtoews authored Mar 21, 2024
1 parent a3110b7 commit 071f731
Show file tree
Hide file tree
Showing 14 changed files with 860 additions and 897 deletions.
24 changes: 15 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,32 @@ labels: bug

<!-- Please search existing issues to avoid creating duplicates. -->


#### Example of problem
Demonstrate the problem you have found, either by using PROJ tools like `cs2cs`, `cct` or `projinfo` **or** add a code snippet that highlights the problem using the PROJ C/C++ API.
A "Minimal, Complete and Verifiable Example" will make it much easier for maintainers to help you:
http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports

Demonstrate the problem you have found, either by using PROJ tools like
`cs2cs`, `cct` or `projinfo` **or** add a code snippet that highlights the
problem using the PROJ C/C++ API.

A "Minimal, Complete and Verifiable Example" will make it much easier for
maintainers to help you: <http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports>

```c
# Your code here

```

#### Problem description

[this should explain **why** the current behavior is a problem and why the expected output is a better solution.]
[this should explain **why** the current behavior is a problem and why the
expected output is a better solution.]

#### Expected Output


#### Environment Information
- PROJ version (`proj`)
- Operation System Information

- PROJ version (`proj`)
- Operation System Information

#### Installation method
- conda, apt-get, from source, etc...

- conda, apt-get, from source, etc...
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Feel free to remove check-list items aren't relevant to your change -->

- [ ] Closes #xxxx
- [ ] Tests added
- [ ] Added clear title that can be used to generate release notes
- [ ] Fully documented, including updating `docs/source/*.rst` for new API
- [ ] Closes #xxxx
- [ ] Tests added
- [ ] Added clear title that can be used to generate release notes
- [ ] Fully documented, including updating `docs/source/*.rst` for new API
26 changes: 26 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

# Heading style
MD003:
style: "atx"

# Unordered list indentation
MD007:
indent: 2

# Line length
MD013: false
# line_length: 100

# Multiple headings with the same content
MD024:
siblings_only: true

# Multiple top-level headings in the same document
MD025: false

# First line in a file should be a top-level heading
MD041: false

# Required heading structure
MD043: true
42 changes: 0 additions & 42 deletions AUTHORS

This file was deleted.

33 changes: 33 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Authors

## Original Author

- Gerald Evenden (1935-2016)

## Maintainers

- Kristian Evers <[email protected]>
- Even Rouault <[email protected]>

## Project Steering Committee

Process and membership can be found at:
<https://proj.org/community/rfc/rfc-1.html>

Chair:

- Kristian Evers <[email protected]>

Members:

- Frank Warmerdam <[email protected]>
- Howard Butler <[email protected]>
- Charles Karney <[email protected]>
- Thomas Knudsen <[email protected]>
- Even Rouault <[email protected]>
- Kurt Schwehr <[email protected]>

## Contributors

The full list of contributors can be found on GitHub
<https://github.com/OSGeo/PROJ/graphs/contributors>
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ if(BUILD_EXAMPLES)
add_subdirectory(examples)
endif()

set(docfiles COPYING NEWS.md AUTHORS)
set(docfiles COPYING NEWS.md AUTHORS.md)
install(FILES ${docfiles}
DESTINATION ${CMAKE_INSTALL_DOCDIR})

Expand Down
9 changes: 4 additions & 5 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ a project may be further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [[email protected]](mailto:[email protected]). All
reported by contacting the project team at <[email protected]>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand All @@ -68,10 +68,9 @@ members of the project's leadership.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
<https://www.contributor-covenant.org/faq>

[homepage]: https://www.contributor-covenant.org
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ account. Familiarity with [issues](https://guides.github.com/features/issues/) a
the [GitHub Flow](https://guides.github.com/introduction/flow/) is an advantage.

## Help a fellow PROJ user

The main forum for support for PROJ is the mailing list. You can subscribe to
the mailing list [here](http://lists.osgeo.org/mailman/listinfo/proj) and read
the archive [here](http://lists.osgeo.org/pipermail/proj/).
Expand Down Expand Up @@ -76,12 +77,12 @@ on GitHub.
If you intend to document one of PROJ's supported projections please use the
[Mercator projection](https://proj.org/operations/projections/merc.html) as a template.


## Code contributions

See [Code Contributions](https://proj.org/community/code_contributions.html)

#### Legalese
### Legalese

Committers are the front line gatekeepers to keep the code base clear of improperly contributed code.
It is important to the PROJ users, developers and the OSGeo foundation to avoid contributing any
code to the project without it being clearly licensed under the project license.
Expand Down Expand Up @@ -122,14 +123,13 @@ improperly contributing code to the source repository:
* If there is uncertainty about whether a change is proper to contribute to the code base, please
seek more information from the project steering committee, or the foundation legal counsel.


## Additional Resources

* [General GitHub documentation](https://help.github.com/)
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)

## Acknowledgements

The _code contribution_ section of this CONTRIBUTING file is inspired by
[PDAL's](https://github.com/PDAL/PDAL/blob/master/CONTRIBUTING.md) and the _legalese_ section is
modified from [GDAL committer guidelines](https://trac.osgeo.org/gdal/wiki/rfc3_commiters)
The [code contribution](#Code Contributions) section of this CONTRIBUTING file is inspired by
[PDAL's](https://github.com/PDAL/PDAL/blob/master/CONTRIBUTING.md) and the [legalese](#legalese)
section is modified from [GDAL committer guidelines](https://trac.osgeo.org/gdal/wiki/rfc3_commiters)
Loading

0 comments on commit 071f731

Please sign in to comment.