Skip to content

Commit 6527d98

Browse files
authored
Fix markdown headers in README.md
Markdown requires a space between the hashes and the header. For example; * `##ABC` doesn't work * `## ABC` works
1 parent cc53347 commit 6527d98

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Open Project Linter
22

3-
##About this project
3+
## About this project
44
The Open Project Linter is an automated checklist that new (or experienced
55
but forgetful) open source maintainers can use to make sure that they're
66
using good practices in their documentation, code, and project resources.
@@ -11,8 +11,8 @@ but these are good practices for most open source projects!
1111

1212
This is written in and supported on Python 3.
1313

14-
##Getting Started
15-
###Installation
14+
## Getting Started
15+
### Installation
1616
It is recommended that you use a virtual environment in order to avoid
1717
dependency conflicts between projects. For more information,
1818
[a tutorial on virtual environments](http://docs.python-guide.org/en/latest/dev/virtualenvs/).
@@ -24,7 +24,7 @@ $ pip install open-project-linter
2424
Once you have installed the package, you should be able to run it from the
2525
command line (see [Example usage](#Example usage)).
2626

27-
###Example usage
27+
### Example usage
2828
Once you have installed the package, if you want to check a local repository,
2929
make sure your virtual enviroment is activated and run:
3030
```
@@ -33,7 +33,7 @@ $ openlinter -d path/to/repository/
3333

3434
For more help, run `$ openlinter --help`.
3535

36-
####Using configuration files
36+
#### Using configuration files
3737
Open Project Linter is configurable, so that you can decide what project
3838
features you want to check for and what file names you want to make sure
3939
exist. The default configuration file is located at
@@ -48,41 +48,41 @@ to use the file located at `path/to/rules.yml` to check the repository at
4848
`path/to/repository/`.
4949

5050
## Contributing
51-
###How to set up the dev environment
51+
### How to set up the dev environment
5252
To set this up for development, fork this repository, then clone it to
5353
your development machine using `git clone`.
5454

5555
Once you've committed your changes and pushed them to your fork of the
5656
repository, file a pull request to get your contribution into the main
5757
repository.
5858

59-
##Changelog
60-
###version 1.0.1
59+
## Changelog
60+
### version 1.0.1
6161
* Fix the error in checking for multiple commits where it was using the reflog
6262
not the commit history ([#30](https://github.com/OpenNewsLabs/open-project-linter/issues/30))
6363

64-
###version 1.0
64+
### version 1.0
6565
* Update `ROADMAP.md` with pre-NICAR status
6666
* Fix the KeyError issue when default config was changed ([#27](https://github.com/OpenNewsLabs/open-project-linter/issues/27))
6767
* Split some of the main linter logic out into functions and improve module
6868
documentation
6969
* Add test fixtures for the git-related tests ([#22](https://github.com/OpenNewsLabs/open-project-linter/issues/22))
7070

71-
###version 0.4dev
71+
### version 0.4dev
7272
* Now installs Pygments automatically when installed with pip, with or
7373
without pulling versions from `requirements.txt`
7474
* Now includes `rules.yml` in the package and uses a correct default path
7575
to it
7676

77-
###version 0.3dev
77+
### version 0.3dev
7878
* Improve documentation
7979
* Fix accidental return value change in file content checker
8080

81-
###version 0.2dev
81+
### version 0.2dev
8282
* Add automated tests
8383
* Fix path bug in file content checker
8484

85-
###version 0.1dev
85+
### version 0.1dev
8686
* Command-line application invokable with `openlinter`, with help on
8787
how to run it
8888
* Given the path to a directory, checks for:
@@ -92,15 +92,15 @@ repository.
9292
multiple commits on any branch, and a named development/feature branch
9393
* Configurable via `rules.yml`
9494

95-
##About
95+
## About
9696
This linter was designed and written by [Frances Hocutt](https://franceshocutt.com/cv/) via [Changeset Consulting](http://changeset.nyc/), a project management and maintainership consultancy focusing on open source. Sumana Harihareswara of Changeset Consulting attended the initial [OpenNews](https://opennews.org/) documentation sprint for [The Field Guide to Open Source in the Newsroom](http://fieldguide.opennews.org/) and suggested development of a companion tool to automate the guidebook's checklists as much as possible.
9797

9898
We look forward to seeing the community add new linter rules to help new maintainers.
9999

100-
##Contributors
100+
## Contributors
101101
* Frances Hocutt - https://franceshocutt.com https://github.com/fhocutt/
102102
* Sumana Harihareswara - https://changeset.nyc
103103

104-
##License
104+
## License
105105
The Open Project Linter is available under v. 2.0 of the Apache license.
106106
See `LICENSE` for more information.

0 commit comments

Comments
 (0)