Skip to content

Commit

Permalink
Updated contribution notes
Browse files Browse the repository at this point in the history
  • Loading branch information
RhetTbull committed Jun 22, 2024
1 parent 1b943d7 commit 2b25532
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ If you want to contribute source code, I recommend you explore the [wiki](https:

See the [README.md](tests/README.md) in the tests directory before running any tests.

Before contributing, please read [README_DEV.md](README_DEV.md) for information on setting up a development environment and opening a pull request.

## Code of Conduct

Be nice to each other. Treat everyone with dignity and respect.

Abusive behavior of any kind will not be tolerated here.
Abusive behavior of any kind will not be tolerated here.
21 changes: 20 additions & 1 deletion README_DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,26 @@ These are notes for developers working on osxphotos. They're mostly to help me r

See the [test README.md](tests/README.md) for more information on running tests.

## Building the package
## Opening a pull request

If you want to contribute to osxphotos, please open a pull request. Here's how to do it:

- Fork the repo on GitHub
- Clone your fork: `git clone [email protected]:YOUR_USERNAME/osxphotos.git`
- Create a virtual environment and install osxphotos as described above
- Create a branch for your changes: `git checkout -b my_branch`
- Make your changes
- Add tests for your changes
- Run the tests: `pytest`
- Update the README.md and other files as needed
- Add your changes using `git add`
- Commit your changes: `git commit -m "My changes description"`
- Push your changes to your fork: `git push origin my_branch`
- Open a [pull request on GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)

## Building the package and executable

**Note**: Do not do this unless you are releasing a new version of osxphotos. This should not be run for normal pull requests. In general, only the maintainer should run the build script.

- Run `./build.sh` to run the build script.

Expand Down

0 comments on commit 2b25532

Please sign in to comment.