Skip to content

Commit

Permalink
add to instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rocco8773 committed Jul 29, 2024
1 parent be8dccf commit d06d039
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,15 @@ up your local `git` repository.
working branch something explicitly descibing what you are adding.
For example, name the working branch `add_gyroradius` for contributing
a formulary function for the gyroradius.
4. Push an instance of your working branch to your GitHub fork of
`plasmapy-summer-school`.
5. Now, add the code associated with your formulary function to the
appropriate `.py` file located in the `./src/hack/formulary` directory.
- As you develop your code try to make frequent, well focused commits.
This is not a strict rule, but will help with debugging errors if,
and when, they occur.
6. Push you commits to GitHub at a regular intervals.
7. When ready, open a Pull Request (PR) from your working branch on your
fork to the `main` branch on the original repository. For detailed
instructions follow GitHub's instructions of
[Creating a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).

0 comments on commit d06d039

Please sign in to comment.