Skip to content

Commit ec2846a

Browse files
stephenrauchjreback
authored andcommitted
Update broken link to contributing.rst in contributing.md (#26286)
1 parent a0c965e commit ec2846a

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

.github/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Whether you are a novice or experienced software developer, all contributions and suggestions are welcome!
44

5-
Our main contributing guide can be found [in this repo](https://github.com/pandas-dev/pandas/blob/master/doc/source/contributing.rst) or [on the website](https://pandas-docs.github.io/pandas-docs-travis/contributing.html). If you do not want to read it in its entirety, we will summarize the main ways in which you can contribute and point to relevant sections of that document for further information.
5+
Our main contributing guide can be found [in this repo](https://github.com/pandas-dev/pandas/blob/master/doc/source/development/contributing.rst) or [on the website](https://pandas-docs.github.io/pandas-docs-travis/contributing.html). If you do not want to read it in its entirety, we will summarize the main ways in which you can contribute and point to relevant sections of that document for further information.
66

77
## Getting Started
88

@@ -18,6 +18,6 @@ If you notice a bug in the code or documentation, or have suggestions for how we
1818

1919
The code is hosted on [GitHub](https://www.github.com/pandas-dev/pandas), so you will need to use [Git](http://git-scm.com/) to clone the project and make changes to the codebase. Once you have obtained a copy of the code, you should create a development environment that is separate from your existing Python environment so that you can make and test changes without compromising your own work environment. For more information, please refer to the "[Working with the code](https://github.com/pandas-dev/pandas/blob/master/doc/source/development/contributing.rst#working-with-the-code)" section.
2020

21-
Before submitting your changes for review, make sure to check that your changes do not break any tests. You can find more information about our test suites in the "[Test-driven development/code writing](https://github.com/pandas-dev/pandas/blob/master/doc/source/contributing.rst#test-driven-development-code-writing)" section. We also have guidelines regarding coding style that will be enforced during testing, which can be found in the "[Code standards](https://github.com/pandas-dev/pandas/blob/master/doc/source/development/contributing.rst#code-standards)" section.
21+
Before submitting your changes for review, make sure to check that your changes do not break any tests. You can find more information about our test suites in the "[Test-driven development/code writing](https://github.com/pandas-dev/pandas/blob/master/doc/source/development/contributing.rst#test-driven-development-code-writing)" section. We also have guidelines regarding coding style that will be enforced during testing, which can be found in the "[Code standards](https://github.com/pandas-dev/pandas/blob/master/doc/source/development/contributing.rst#code-standards)" section.
2222

2323
Once your changes are ready to be submitted, make sure to push your changes to GitHub before creating a pull request. Details about how to do that can be found in the "[Contributing your changes to pandas](https://github.com/pandas-dev/pandas/blob/master/doc/source/development/contributing.rst#contributing-your-changes-to-pandas)" section. We will review your changes, and you will most likely be asked to make additional changes before it is finally ready to merge. However, once it's ready, we will merge it, and you will have successfully contributed to the codebase!

doc/source/development/contributing.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -351,11 +351,11 @@ Some other important things to know about the docs:
351351

352352
The ``.rst`` files are used to automatically generate Markdown and HTML versions
353353
of the docs. For this reason, please do not edit ``CONTRIBUTING.md`` directly,
354-
but instead make any changes to ``doc/source/contributing.rst``. Then, to
354+
but instead make any changes to ``doc/source/development/contributing.rst``. Then, to
355355
generate ``CONTRIBUTING.md``, use `pandoc <http://johnmacfarlane.net/pandoc/>`_
356356
with the following command::
357357

358-
pandoc doc/source/contributing.rst -t markdown_github > CONTRIBUTING.md
358+
pandoc doc/source/development/contributing.rst -t markdown_github > CONTRIBUTING.md
359359

360360
The utility script ``scripts/validate_docstrings.py`` can be used to get a csv
361361
summary of the API documentation. And also validate common errors in the docstring

0 commit comments

Comments
 (0)