Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update readme with author workflow feedback #898

Merged
merged 6 commits into from
May 7, 2024
Merged

Update readme with author workflow feedback #898

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f911fb0
Update readme with author workflow feedback
mepa May 3, 2024
d6f6393
Reviewer feedback
mepa May 3, 2024
15080be
Reviewer feedback
mepa May 3, 2024
61d07ff
Reviewer feedback
mepa May 3, 2024
56b15a3
Add webinar link to README.md
cbcunc May 7, 2024
414058e
Reviewer feedback
mepa May 7, 2024
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
31 changes: 18 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,10 +212,10 @@ in code examples, you should replace that with your GitHub username.
More generally, angle brackets with a value inside are meant to be replaced with
the value that applies to you.

For example, if your GitHub username was `mpacer`, you would transform
For example, if you typically clone using the web URL, and your GitHub username was `mpacer`, you would transform

```
git clone https://github.com/<username>/scipy_proceedings
git clone <scheme>github.com/<username>/scipy_proceedings
mepa marked this conversation as resolved.
Show resolved Hide resolved
```

into:
Expand All @@ -226,13 +226,13 @@ git clone https://github.com/mpacer/scipy_proceedings

#### Author workflow steps
cbcunc marked this conversation as resolved.
Show resolved Hide resolved

1. Get a local copy of the `scipy_proceedings` repo.
2. Update your local copy of the `scipy_proceedings` repo.
1. [Get a local copy](#getting-a-local-copy-of-the-scipy_proceedings-repo) of the `scipy_proceedings` repo.
2. [Update your local copy](#getting-the-latest-branch) of the `scipy_proceedings` repo.
3. [Create a new branch](#creating-a-new-branch) for your paper based off the latest `2024` branch.
- If you submit multiple papers, you will need a new branch for each.
4. [Install MyST Markdown and Node](#setting-up-your-environment) and [copy a template](#setting-up-your-environment).
5. [Write your paper](#write-your-paper), [commit changes](#commit-your-changes), and [build your paper](#preview-your-paper)
6. [Create a PR](#create-a-paper-pr) or [push changes to your PR's branch](#push-your-changes) and [check your paper](#check-your-paper).
6. [Create a PR](#create-a-paper-pr) or [push changes to your PR's branch](#commit-your-changes) and [check your paper](#check-your-papers-build).
- If you want to alter the build system, do not include it in your
mepa marked this conversation as resolved.
Show resolved Hide resolved
submission's PR, create a separate PR against `dev`
([see below](#creating-build-system-prs) for more details).
Expand All @@ -245,18 +245,20 @@ git clone https://github.com/mpacer/scipy_proceedings
[scipy_proceedings](https://github.com/scipy-conference/scipy_proceedings)
repository on GitHub.
- Clone the repo locally
- `git clone https://github.com/<username>/scipy_proceedings`
- replace `<scheme>` with `git@` or `https://`, for example
- replace `<username>` with your GitHub username
- `git clone <scheme>github.com/<username>/scipy_proceedings`
mepa marked this conversation as resolved.
Show resolved Hide resolved
- `cd scipy_proceedings/`
- Add the `scipy-conference` repository as your `upstream` remote
- `git remote add upstream https://github.com/scipy-conference/scipy_proceedings`
- `git remote add upstream <scheme>github.com/scipy-conference/scipy_proceedings`

If you run `git remote -v ` you should see something like the following:
If you run `git remote -v ` you should see something like the following:

```
origin https://github.com/<username>/scipy_proceedings.git (fetch)
origin https://github.com/<username>/scipy_proceedings.git (push)
upstream https://github.com/scipy-conference/scipy_proceedings.git (fetch)
upstream https://github.com/scipy-conference/scipy_proceedings.git (push)
origin <scheme>github.com/<username>/scipy_proceedings.git (fetch)
origin <scheme>github.com/<username>/scipy_proceedings.git (push)
upstream <scheme>github.com/scipy-conference/scipy_proceedings.git (fetch)
upstream <scheme>github.com/scipy-conference/scipy_proceedings.git (push)
```

#### Getting the latest branch
Expand Down Expand Up @@ -330,7 +332,7 @@ Once you are ready to submit your paper, make a pull request on GitHub. **Please

- Create a pull request against the `2024` branch
- Do not modify any files outside of your paper directory. Create a separate PR for any changes to the build system.
- Ensure that your PR has a `paper` label, if not, one will be added for you
- Ensure that your PR title begins with `Paper:`.
mepa marked this conversation as resolved.
Show resolved Hide resolved

#### Creating build system PRs

Expand All @@ -355,6 +357,9 @@ If it is not the same, please immediately contact us with a GitHub issue
describing the discrepancy. Please include screenshots and an explanation of the
differences. For best results, please [@-mention the Proceedings Co-Chairs](#contacting-the-proceedings-co-chairs).

#### A note on notebooks for 2024
We are interested in working towards full support for publishing computational notebooks as part of the proceedings, and are trialing this part of the submission process for interested authors - please get in touch with the Proceedings Co-Chairs with your interest.

## Instructions for Reviewers

You will be reviewing authors' pull requests. While authors should have a proper
Expand Down