Skip to content

Commit bd708f1

Browse files
authored
Documentation (#7166)
I found it difficult to find the instructions for setting up a development environment with my usual GitHub habits. In fact, I assumed they don't exist and missed the very helpful information. I hope that this commit will help others find them.
1 parent c1336ae commit bd708f1

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

Diff for: CONTRIBUTING.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,5 @@ and brings value to both new and experienced users of Material for MkDocs.
5858
[Request a change]: docs/contributing/requesting-a-change.md
5959
[Ask a question]: https://github.com/squidfunk/mkdocs-material/discussions
6060
[Add a translation]: docs/contributing/adding-translations
61-
[Create a pull request]: https://github.com/squidfunk/mkdocs-material/pulls
61+
[Create a pull request]: docs/contributing/making-a-pull-request.md
62+

Diff for: docs/contributing/making-a-pull-request.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,11 @@ sequenceDiagram
102102
branch will be relatively short-lived and will disappear at the end, when
103103
your changes have been incorporated into the codebase.
104104

105-
4. Next comes the iterative process of making edits, committing them to your
105+
4. If you intend to make any code changes, as opposed to working on
106+
documentation only, you will need to [set up a development
107+
environment](#setting-up-a-development-environment).
108+
109+
5. Next comes the iterative process of making edits, committing them to your
106110
clone. Please commit in sensible chunks that constitute a piece of work
107111
instead of committing everything in one go.
108112

@@ -112,23 +116,23 @@ sequenceDiagram
112116
reviewer in mind when committing. In particular, make sure to write
113117
meaningful commit messages.
114118

115-
5. Push your work up to your fork regularly.
119+
6. Push your work up to your fork regularly.
116120

117-
6. You should also keep an eye on changes in the Material for MkDocs repository
121+
7. You should also keep an eye on changes in the Material for MkDocs repository
118122
you cloned. This is especially important if you work takes a while. Please
119123
try and merge any concurrent changes into your fork and into your branch
120124
regularly. You *must* do this at least once before creating a pull request,
121125
so make your life easier and do it more often so as to minimize the risk of
122126
conflicting changes.
123127

124-
7. Once you are happy that your changes are in a state that you can describe
128+
8. Once you are happy that your changes are in a state that you can describe
125129
them in a *draft* pull request, you should create this. Make sure to
126130
reference any previous discussions or issues that gave rise to your work.
127131
Creating a draft is a good way to get *early* feedback on your work from the
128132
maintainer or others. You can explicitly request reviews at points where you
129133
think this would be important.
130134

131-
8. Review your work as if you were the reviewer and fix any issues with your
135+
9. Review your work as if you were the reviewer and fix any issues with your
132136
work so far. Look critically at the diffs of the files that you have changed.
133137
In particular, pay attention to whether the changes are as small as possible
134138
and whether you have follow the general coding style used in the project.

0 commit comments

Comments
 (0)