-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Move all relevant wiki items to docs #47277
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6a2dab0
DOC: Move all relevant wiki items to docs
mroeschke 5f5396a
Merge remote-tracking branch 'upstream/main' into move/wiki
mroeschke 5117788
Merge remote-tracking branch 'upstream/main' into move/wiki
mroeschke efca708
Merge remote-tracking branch 'upstream/main' into move/wiki
mroeschke 2e2b06f
Address review
mroeschke File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -138,7 +138,7 @@ Reviewing pull requests | |
----------------------- | ||
|
||
Anybody can review a pull request: regular contributors, triagers, or core-team | ||
members. But only core-team members can merge pull requets when they're ready. | ||
members. But only core-team members can merge pull requests when they're ready. | ||
|
||
Here are some things to check when reviewing a pull request. | ||
|
||
|
@@ -151,16 +151,37 @@ Here are some things to check when reviewing a pull request. | |
for regression fixes and small bug fixes, the next minor milestone otherwise) | ||
* Changes should comply with our :ref:`policies.version`. | ||
|
||
|
||
.. _maintaining.backporting: | ||
|
||
Backporting | ||
----------- | ||
|
||
In the case you want to apply changes to a stable branch from a newer branch then you | ||
can comment:: | ||
pandas supports point releases (e.g. ``1.4.3``) that aim to: | ||
|
||
1. Fix bugs in new features introduced since the first minor version release. | ||
mroeschke marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* If a new feature was added in ``1.4`` and contains a bug, a fix can be applied in ``1.4.3`` | ||
|
||
2. Fix bugs that used to work in a few minor releases prior. | ||
|
||
* If a feature worked in ``1.2`` and stopped working since ``1.3``, a fix can be applied in ``1.4.3``. | ||
mroeschke marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Since pandas minor releases are based on Github branches (e.g. point release of ``1.4`` are based off the ``1.4.x`` branch), | ||
"backporting" means merging a pull request fix to the ``main`` branch and correct minor branch associated with the next point release. | ||
|
||
By default, if a pull request is assigned to the next point release milestone within the Github interface, | ||
the backporting process should happen automatically by the ``@meeseeksdev`` bot once the pull request is merged. | ||
A new pull request will be made backporting the pull request to the correct version branch. | ||
Sometimes due to merge conflicts, a manual pull request will need to be made addressing the code conflict. | ||
|
||
If the bot does not automatically start the backporting process, you can also write a Github comment in the merged pull request | ||
to trigger the backport:: | ||
|
||
@meeseeksdev backport version-branch | ||
|
||
This will trigger a workflow which will backport a given change to a branch | ||
(e.g. @meeseeksdev backport 1.2.x) | ||
(e.g. @meeseeksdev backport 1.4.x) | ||
|
||
Cleaning up old issues | ||
---------------------- | ||
|
@@ -204,6 +225,18 @@ The full process is outlined in our `governance documents`_. In summary, | |
we're happy to give triage permissions to anyone who shows interest by | ||
being helpful on the issue tracker. | ||
|
||
The required steps for adding a maintainer are: | ||
|
||
1. Contact the contributor and ask their interest to join. | ||
2. Add the contributor to the appropriate `Github Team <https://github.com/orgs/pandas-dev/teams>`_ if accepted the invitation. | ||
|
||
* ``pandas-core`` is for core team members | ||
* ``pandas-triage`` is for pandas triage members | ||
|
||
3. Add the contributor to the pandas Google group. | ||
4. Create a pull request to add the contributor's Github handle to ``pandas-dev/pandas/web/pandas/config.yml``. | ||
5. Create a pull request to add the contributor's name/Github handle to the `governance document <https://github.com/pandas-dev/pandas-governance/blob/master/people.md>`_. | ||
|
||
The current list of core-team members is at | ||
https://github.com/pandas-dev/pandas-governance/blob/master/people.md | ||
|
||
|
@@ -236,5 +269,40 @@ a milestone before tagging, you can request the bot to backport it with: | |
@Meeseeksdev backport <branch> | ||
|
||
|
||
.. _maintaining.asv-machine: | ||
|
||
Benchmark machine | ||
----------------- | ||
|
||
The team currently owns dedicated hardware for hosting a website for pandas' ASV performance benchmark. The results | ||
are published to http://pandas.pydata.org/speed/pandas/ | ||
|
||
Configuration | ||
````````````` | ||
|
||
The machine can be configured with the `Ansible <http://docs.ansible.com/ansible/latest/index.html>`_ playbook in https://github.com/tomaugspurger/asv-runner. | ||
|
||
Publishing | ||
`````````` | ||
|
||
The results are published to another Github repository, https://github.com/tomaugspurger/asv-collection. | ||
Finally, we have a cron job on our docs server to pull from https://github.com/tomaugspurger/asv-collection, to serve them from ``/speed``. | ||
Ask Tom or Joris for access to the webserver. | ||
|
||
Debugging | ||
````````` | ||
|
||
The benchmarks are scheduled by Airflow. It has a dashboard for viewing and debugging the results. You'll need to setup an SSH tunnel to view them | ||
|
||
ssh -L 8080:localhost:8080 [email protected] | ||
|
||
|
||
.. _maintaining.release: | ||
|
||
Release process | ||
--------------- | ||
|
||
The process for releasing a new version of pandas can be found at https://github.com/pandas-dev/pandas-release | ||
|
||
.. _governance documents: https://github.com/pandas-dev/pandas-governance | ||
.. _list of permissions: https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.