@@ -32,12 +32,6 @@ Still aren't sure what you have to offer? Just :discussion-type:`ask us <questio
32
32
we'll help you make your first contribution.
33
33
34
34
35
- .. note ::
36
-
37
- If you have any questions during set up or development post on our
38
- :discussion-type: `discussion board <question> ` and we'll answer them.
39
-
40
-
41
35
Making a Pull Request
42
36
---------------------
43
37
@@ -53,21 +47,25 @@ about how to get started. To make a change to IDOM you'll do the following:
53
47
You use a ``git clone `` command to copy the code from GitHub to your computer.
54
48
55
49
`Create a new branch <https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging >`__:
56
- You'll ``git checkout -b your-first-branch `` to create a new space to start your work
50
+ You'll ``git checkout -b your-first-branch `` to create a new space to start your work.
57
51
58
52
:ref: `Prepare your Development Environment <Development Environment >`:
59
- We explain in more detail below how to install all IDOM's dependencies
53
+ We explain in more detail below how to install all IDOM's dependencies.
60
54
61
55
`Push your changes <https://docs.github.com/en/github/using-git/pushing-commits-to-a-remote-repository >`__:
62
56
Once you've made changes to IDOM, you'll ``git push `` them to your fork.
63
57
58
+ :ref: `Create a changelog entry <Creating a changelog entry >`:
59
+ Record your changes in the :ref: `changelog ` so we can publicize them in the next release.
60
+
64
61
`Create a Pull Request <https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request >`__:
65
62
We'll review your changes, run some :ref: `tests <Running The Tests >` and
66
63
:ref: `equality checks <Code Quality Checks >` and, with any luck, accept your request.
67
64
At that point your contribution will be merged into the main codebase!
68
65
66
+
69
67
Creating a Changelog Entry
70
- ..........................
68
+ --------------------------
71
69
72
70
As part of your pull request, you'll want to edit the `Changelog
73
71
<https://github.com/idom-team/idom/blob/main/docs/source/about/changelog.rst> `__ by
@@ -112,6 +110,11 @@ might look like:
112
110
Development Environment
113
111
-----------------------
114
112
113
+ .. note ::
114
+
115
+ If you have any questions during set up or development post on our
116
+ :discussion-type: `discussion board <question> ` and we'll answer them.
117
+
115
118
In order to develop IDOM locally you'll first need to install the following:
116
119
117
120
.. list-table ::
@@ -120,7 +123,7 @@ In order to develop IDOM locally you'll first need to install the following:
120
123
* - What to Install
121
124
- How to Install
122
125
123
- * - Git _
126
+ * - Git
124
127
- https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
125
128
126
129
* - Python >= 3.7
0 commit comments