Skip to content

Commit 3303a88

Browse files
authored
Update contributing guide
1 parent 8a4b1f9 commit 3303a88

File tree

1 file changed

+0
-11
lines changed

1 file changed

+0
-11
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,6 @@ 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,
15-
I intend to merge functionality in this plugin with [mkdocs-git-authors-plugin](https://github.com/timvink/mkdocs-git-authors-plugin).
16-
See https://github.com/timvink/mkdocs-git-authors-plugin/issues/16 for a similar roadmap issue with more details.
17-
18-
That means not extending the functionality of this plugin, but rather aiming to create a simple, stable release that can go into 'maintenance mode'.
19-
If users want more information extracted from Git, they can go to [mkdocs-git-authors-plugin](https://github.com/timvink/mkdocs-git-authors-plugin).
20-
2110
## Unit Tests
2211

2312
Make sure to install an editable version before running the tests:

0 commit comments

Comments
 (0)