@@ -102,7 +102,11 @@ sequenceDiagram
102
102
branch will be relatively short-lived and will disappear at the end, when
103
103
your changes have been incorporated into the codebase.
104
104
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
106
110
clone. Please commit in sensible chunks that constitute a piece of work
107
111
instead of committing everything in one go.
108
112
@@ -112,23 +116,23 @@ sequenceDiagram
112
116
reviewer in mind when committing. In particular, make sure to write
113
117
meaningful commit messages.
114
118
115
- 5 . Push your work up to your fork regularly.
119
+ 6 . Push your work up to your fork regularly.
116
120
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
118
122
you cloned. This is especially important if you work takes a while. Please
119
123
try and merge any concurrent changes into your fork and into your branch
120
124
regularly. You * must* do this at least once before creating a pull request,
121
125
so make your life easier and do it more often so as to minimize the risk of
122
126
conflicting changes.
123
127
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
125
129
them in a * draft* pull request, you should create this. Make sure to
126
130
reference any previous discussions or issues that gave rise to your work.
127
131
Creating a draft is a good way to get * early* feedback on your work from the
128
132
maintainer or others. You can explicitly request reviews at points where you
129
133
think this would be important.
130
134
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
132
136
work so far. Look critically at the diffs of the files that you have changed.
133
137
In particular, pay attention to whether the changes are as small as possible
134
138
and whether you have follow the general coding style used in the project.
0 commit comments