Skip to content
This repository has been archived by the owner on Jun 12, 2023. It is now read-only.

Update README.md #14

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,32 @@ Release automation for pandas.
- [ ] `TAG` in `Makefile`
- [ ] `GH_USERNAME` in `Makefile`

If running for the first time be sure to initialize repos
## **If running for the first time:**

- Create a conda enviroment based on environment.yml:
```sh
conda env create
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be conda env create -f environment.yaml?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

environment.yml is the default conda file name, so not needed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, even if it is the default, I find leaving it out just confusing (for all people that don't know or directly remember that this is the default)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I see the non-explicit form is confusing to people. will change it back :D

```
- Activate the environment:
```sh
conda activate pandas-release
Aya-S marked this conversation as resolved.
Show resolved Hide resolved
```
- Be sure you have the following forked on your github:
- https://github.com/pandas-dev/pandas-website
- https://github.com/conda-forge/pandas-feedstock
- https://github.com/MacPython/pandas-wheels
- https://github.com/pandas-dev/pandas

 
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this required for anything?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It introduces a newline. for better readability and clearer separation between the commands


- Be sure to initialize repos:
```sh
make init-repos
```

The `environment.yml` contains the local dependencies. You'll
also need docker.

And fork pandas-feedstock and pandas-wheels to your GitHub account.

```
# Update repos
make update-repos
Expand Down