Skip to content

Commit b7de714

Browse files
marenwestermannnoatamir
authored andcommitted
DOC: update contributing to pandas documentation (pandas-dev#48113)
* update contributing to pandas documentation * address requested changes * fix typo
1 parent 542edd4 commit b7de714

File tree

1 file changed

+19
-27
lines changed

1 file changed

+19
-27
lines changed

doc/source/development/contributing.rst

+19-27
Original file line numberDiff line numberDiff line change
@@ -194,30 +194,10 @@ Doing 'git status' again should give something like::
194194
# modified: /relative/path/to/file-you-added.py
195195
#
196196

197-
Finally, commit your changes to your local repository with an explanatory message. pandas
198-
uses a convention for commit message prefixes and layout. Here are
199-
some common prefixes along with general guidelines for when to use them:
197+
Finally, commit your changes to your local repository with an explanatory commit
198+
message::
200199

201-
* ENH: Enhancement, new functionality
202-
* BUG: Bug fix
203-
* DOC: Additions/updates to documentation
204-
* TST: Additions/updates to tests
205-
* BLD: Updates to the build process/scripts
206-
* PERF: Performance improvement
207-
* TYP: Type annotations
208-
* CLN: Code cleanup
209-
210-
The following defines how a commit message should be structured. Please reference the
211-
relevant GitHub issues in your commit message using GH1234 or #1234. Either style
212-
is fine, but the former is generally preferred:
213-
214-
* a subject line with ``< 80`` chars.
215-
* One blank line.
216-
* Optionally, a commit message body.
217-
218-
Now you can commit your changes in your local repository::
219-
220-
git commit -m
200+
git commit -m "your commit message goes here"
221201

222202
.. _contributing.push-code:
223203

@@ -262,16 +242,28 @@ double check your branch changes against the branch it was based on:
262242
Finally, make the pull request
263243
------------------------------
264244

265-
If everything looks good, you are ready to make a pull request. A pull request is how
245+
If everything looks good, you are ready to make a pull request. A pull request is how
266246
code from a local repository becomes available to the GitHub community and can be looked
267-
at and eventually merged into the main version. This pull request and its associated
247+
at and eventually merged into the main version. This pull request and its associated
268248
changes will eventually be committed to the main branch and available in the next
269-
release. To submit a pull request:
249+
release. To submit a pull request:
270250

271251
#. Navigate to your repository on GitHub
272-
#. Click on the ``Pull Request`` button
252+
#. Click on the ``Compare & pull request`` button
273253
#. You can then click on ``Commits`` and ``Files Changed`` to make sure everything looks
274254
okay one last time
255+
#. Write a descriptive title that includes prefixes. pandas uses a convention for title
256+
prefixes. Here are some common ones along with general guidelines for when to use them:
257+
258+
* ENH: Enhancement, new functionality
259+
* BUG: Bug fix
260+
* DOC: Additions/updates to documentation
261+
* TST: Additions/updates to tests
262+
* BLD: Updates to the build process/scripts
263+
* PERF: Performance improvement
264+
* TYP: Type annotations
265+
* CLN: Code cleanup
266+
275267
#. Write a description of your changes in the ``Preview Discussion`` tab
276268
#. Click ``Send Pull Request``.
277269

0 commit comments

Comments
 (0)