Skip to content

Commit fd2781d

Browse files
authored
Add vision to CONTRIBUTING.md, closes #29
1 parent d5fcf88 commit fd2781d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Thanks for considering to contribute to this project! Some guidelines:
77
- This package tries to be as simple as possible for the user (hide any complexity from the user). New options are only added when there is clear value to the majority of users.
88
- When issues or pull requests are not going to be resolved or merged, they should be closed as soon as possible. This is kinder than deciding this after a long period. Our issue tracker should reflect work to be done.
99

10+
## Vision
11+
12+
There are multiple mkdocs plugins that use information from the local git repo.
13+
14+
In order to simplify user experience and maintenance, I intend to merge functionality in this plugin with [mkdocs-git-authors-plugin](https://github.com/timvink/mkdocs-git-authors-plugin). See https://github.com/timvink/mkdocs-git-authors-plugin/issues/16 for a similar roadmap issue with more details.
15+
16+
That means not extending the functionality of this plugin, but rather aiming to create a simple, stable release that can go into 'maintenance mode'. If users want more information extracted from GIT, they can go to [mkdocs-git-authors-plugin](https://github.com/timvink/mkdocs-git-authors-plugin).
17+
1018
## Unit Tests
1119

1220
Make sure to install an editable version before running the tests:
@@ -40,4 +48,4 @@ mkdocs serve -f tests/fixtures/basic_project/mkdocs.yml
4048

4149
Make sure your code *roughly* follows [PEP-8](https://www.python.org/dev/peps/pep-0008/) and keeps things consistent with the rest of the code.
4250

43-
We use google-style docstrings.
51+
We use google-style docstrings.

0 commit comments

Comments
 (0)