First off, thank you for considering contributing to Simple BuddyPress Signup Avatar! It's people like you that make this plugin a great tool for the WordPress community.
- Code of Conduct
- Where do I go from here?
- Fork & Create a Branch
- Get the Test Suite Running
- Implement Your Fix or Feature
- Get the Style Right
- Make a Pull Request
- Keeping Your Pull Request Updated
- Merging a PR (Maintainers Only)
- Shipping a Release (Maintainers Only)
This project and everyone participating in it is governed by the Simple BuddyPress Signup Avatar Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the Plugin Author.
If you've noticed a bug or have a feature request, make sure to check our Issues page to see if someone else has already created a ticket. If not, go ahead and make one!
If this is something you think you can fix or implement yourself, here's how to get started:
- Fork the repository to your own Github account
- Clone the project to your machine
git clone https://github.com/your-username/simple-buddypress-signup-avatar.git
- Create a branch locally with a succinct but descriptive name
git checkout -b 325-add-japanese-translations
Make sure you're using the latest version of WordPress and BuddyPress for testing.
To run the tests, follow these steps:
- Install PHPUnit
- Run
phpunitin the plugin directory
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first.
Your patch should follow the same coding conventions as the rest of the project. We use WordPress Coding Standards. You can check your code using PHP_CodeSniffer with the WordPress ruleset.
At this point, you should switch back to your master branch and make sure it's up to date with the master branch:
git remote add upstream git@github.com:original-owner-username/original-repository.git
git checkout master
git pull upstream masterThen update your feature branch from your local copy of master, and push it!
git checkout 325-add-japanese-translations
git rebase master
git push --set-upstream origin 325-add-japanese-translationsFinally, go to GitHub and make a Pull Request
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
Here's the suggested workflow:
git checkout 325-add-japanese-translations
git pull --rebase upstream master
git push --force-with-lease 325-add-japanese-translationsA PR can only be merged into master by a maintainer if:
- It is passing CI.
- It has been approved by at least two maintainers. If it was a maintainer who opened the PR, only one extra approval is needed.
- It has no requested changes.
- It is up to date with current master.
Any maintainer is allowed to merge a PR if all of these conditions are met.
Maintainers need to do the following to push out a release:
- Make sure all tests are passing on the latest master.
- Update the version number in the plugin's main PHP file and readme.txt.
- Update the changelog in readme.txt.
- Commit these changes with the message "Bump to version X.X.X".
- Tag the release in git with the version number, e.g., git tag v1.0.0.
- Push the changes and the tag: git push && git push --tags.
When filing an issue, make sure to answer these five questions:
- What version of WordPress and BuddyPress are you using?
- What version of the plugin are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
If you find yourself wishing for a feature that doesn't exist in Simple BuddyPress Signup Avatar, you are probably not alone. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.
Thank you for your contribution!