From 2b2553292c79e5ba96c6435b2e93f00b9b3f1553 Mon Sep 17 00:00:00 2001 From: Rhet Turnbull Date: Sat, 22 Jun 2024 08:21:15 -0700 Subject: [PATCH] Updated contribution notes --- CONTRIBUTING.md | 4 +++- README_DEV.md | 21 ++++++++++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 652690399..007caaeae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. \ No newline at end of file +Abusive behavior of any kind will not be tolerated here. diff --git a/README_DEV.md b/README_DEV.md index 21beb4450..79e1b5d14 100644 --- a/README_DEV.md +++ b/README_DEV.md @@ -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 git@github.com: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.