Skip to content

Commit

Permalink
upper level content renaming
Browse files Browse the repository at this point in the history
  • Loading branch information
BradleySappington committed Dec 10, 2024
1 parent d80d4fc commit 7f26d0a
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ authors:
family-names: "Otor"
affiliation: "Otor"
orcid: 'https://orcid.org/0000-0002-4679-5692'
repository-code: 'https://github.com/spacetelescope/webbpsf'
repository-code: 'https://github.com/spacetelescope/stpsf'
abstract: >-
WebbPSF produces simulated PSFs for the James Webb Space
Telescope, NASA's flagship infrared space telescope.
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Please open a new issue or new pull request for bugs, feedback, or new features
See the instructions below for how to contribute to this repository using a forking workflow.

#### Forking Workflow
1. Create a personal fork of the `webbpsf` repository by visiting its location on GitHub and clicking the `Fork` button. This will create a copy of the `webbpsf` repository under your personal GitHub account (hereby referred to as "personal fork"). Note that this only has to be done once.
1. Create a personal fork of the `stpsf` repository by visiting its location on GitHub and clicking the `Fork` button. This will create a copy of the `stpsf` repository under your personal GitHub account (hereby referred to as "personal fork"). Note that this only has to be done once.

2. Make a local copy of your personal fork by cloning the repository (e.g. `git clone https://github.com/username/webbpsf.git`, found by clicking the green "clone or download" button.). Note that, unless you explicitly delete your clone of the fork, this only has to be done once.
2. Make a local copy of your personal fork by cloning the repository (e.g. `git clone https://github.com/username/stpsf.git`, found by clicking the green "clone or download" button.). Note that, unless you explicitly delete your clone of the fork, this only has to be done once.

3. Ensure that the personal fork is pointing to the `upstream` `webbpsf` repository with `git remote add upstream https://github.com/spacetelescope/webbpsf.git` (or use the SSH version if you have your SSH keys set up). Note that, unless you explicitly change the remote location of the repository, this only has to be done once.
3. Ensure that the personal fork is pointing to the `upstream` `stpsf` repository with `git remote add upstream https://github.com/spacetelescope/stpsf.git` (or use the SSH version if you have your SSH keys set up). Note that, unless you explicitly change the remote location of the repository, this only has to be done once.

4. Create a branch off of the `develop` branch on the personal clone to develop software changes on. Branch names should be short but descriptive (e.g. `new-database-table` or `fix-ingest-algorithm`), and not too generic (e.g. `bug-fix`). Consistent use of hyphens is encouraged.
1. `git branch <branchname>`
Expand All @@ -21,16 +21,16 @@ See the instructions below for how to contribute to this repository using a fork

5. Push the branch to the GitHub repository for the personal fork with `git push origin <branchname>`.

6. In the `webbpsf` repository, create a pull request for the recently pushed branch. You will want to set the base fork pointing to `webbpsf:develop` and the `head` fork pointing to the branch on your personal fork (i.e. `username:branchname`). Note that if the branch is still under development, you can use the GitHub "Draft" feature (under the "Reviewers" section) to tag the pull request as a draft. Not until the "Ready for review" button at the bottom of the pull request is explicitly pushed is the pull request 'mergeable'.
6. In the `stpsf` repository, create a pull request for the recently pushed branch. You will want to set the base fork pointing to `stpsf:develop` and the `head` fork pointing to the branch on your personal fork (i.e. `username:branchname`). Note that if the branch is still under development, you can use the GitHub "Draft" feature (under the "Reviewers" section) to tag the pull request as a draft. Not until the "Ready for review" button at the bottom of the pull request is explicitly pushed is the pull request 'mergeable'.

7. Assign the pull request a reviewer, selecting a maintainer of the `webbpsf` repository. They will review your pull request and either accept the request and merge, or ask for additional changes.
7. Assign the pull request a reviewer, selecting a maintainer of the `stpsf` repository. They will review your pull request and either accept the request and merge, or ask for additional changes.

8. Iterate with your reviewer(s) on additional changes if necessary, addressing any comments on your pull request. If changes are required, you may end up iterating over steps 4.iii and 5 several times while working with your reviewer.

9. Once the pull request has been accepted and merged, you can delete your local branch with `git branch -d <branchname>`.

#### Keeping your fork updated
If you wish to, you can keep a personal fork up-to-date with the `webbpsf` repository by fetching and rebasing with the `upstream` remote. Do this for both the `master` branch (shown below) and the `develop` branch:
If you wish to, you can keep a personal fork up-to-date with the `stpsf` repository by fetching and rebasing with the `upstream` remote. Do this for both the `master` branch (shown below) and the `develop` branch:
1. `git checkout master`
2. `git fetch upstream master`
3. `git rebase upstream/master`
Expand Down
6 changes: 3 additions & 3 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
include README.rst
recursive-include webbpsf/otelm *.fits *.txt
recursive-include webbpsf/tests/surs *.xml
recursive-include stpsf/otelm *.fits *.txt
recursive-include stpsf/tests/surs *.xml

recursive-include webbpsf *.pyx *.c
recursive-include stpsf *.pyx *.c
include setup.cfg
include pyproject.toml

Expand Down

0 comments on commit 7f26d0a

Please sign in to comment.