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

Add extra info to make contributing easier. #253

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Add extra info to make contributing easier. #253

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Please use a dedicated repository [pybugreports](https://github.com/pyanodon/pyb

## Contributing

The stable public release is on the "Frozen" branch so if you want to test changes or make a pull request to put your changes into the public repository then you will have to use that branch.
This also means that when forking you will have to deselect "Copy the master branch only" as it is enabled by default.
When making a Pull Request, please also update `changelog.txt` with the summary of your changes.
If there is no upcoming version in the file, then the format is as follows:
```
Expand All @@ -15,3 +17,12 @@ Date: ???
- The summary of your changes
---------------------------------------------------------------------------------------------------
```

Here is a quick guide on how to initiate a code review/pull request if you have never done so on Github.
- Fork the repository (button in the top right on Github), it makes a private copy of it.
- Deselect "Copy the master branch only" when making the fork so we also get the "Frozen" branch.
- Clone your fork onto your PC.
- Switch to the "Frozen" branch.
- Make your changes, make your commit(s), test whether they do what you want.
- Push the commit(s) to your private fork repository.
- Use Github to initiate a pull request in your private fork repository (button on the top, says "Compare & pull request"). If you have multiple commits it will create one pull request for all of them together.
Loading