| 1 |
#Contribute To UsersWP |
| 2 |
|
| 3 |
Community made patches, localisations, bug reports and contributions are always welcome. |
| 4 |
|
| 5 |
When contributing please ensure you follow the guidelines below so that we can keep on top of things. |
| 6 |
|
| 7 |
__Please Note:__ GitHub is for bug reports and contributions only - if you have a support question or a request for a customization don't post here, go to our [](https://userswp.io/support/Support page](https://userswp.io/support/](https://userswp.io/support/) instead. |
| 8 |
|
| 9 |
## Getting Started |
| 10 |
|
| 11 |
* __Do not report potential security vulnerabilities here. Email them privately to our security team at [](mailto:info@userswp.ioinfo@userswp.io](mailto:info@userswp.io](mailto:info@userswp.io)__ |
| 12 |
* Submit a ticket for your issue, assuming one does not already exist. |
| 13 |
* Raise it on our [](https://github.com/UsersWP/userswp/issuesIssue Tracker](https://github.com/UsersWP/userswp/issues](https://github.com/UsersWP/userswp/issues) |
| 14 |
* Clearly describe the issue including steps to reproduce the bug. |
| 15 |
* Make sure you fill in the earliest version that you know has the issue as well as the version of WordPress you're using. |
| 16 |
|
| 17 |
## Making Changes |
| 18 |
|
| 19 |
* Fork the repository on GitHub |
| 20 |
* Make the changes to your forked repository |
| 21 |
* Ensure you stick to the [](https://codex.wordpress.org/WordPress_Coding_StandardsWordPress Coding Standards](https://codex.wordpress.org/WordPress_Coding_Standards](https://codex.wordpress.org/WordPress_Coding_Standards) |
| 22 |
* When committing, reference your issue (if present) and include a note about the fix |
| 23 |
* If possible, and if applicable, please also add/update unit tests for your changes |
| 24 |
* Push the changes to your fork and submit a pull request to the 'master' branch of the EDD repository |
| 25 |
|
| 26 |
## Code Documentation |
| 27 |
|
| 28 |
* We ensure that every GeoDirectory function is documented well and follows the standards set by phpDoc |
| 29 |
* Please make sure that every function is documented so that when we update our API Documentation things don't go awry! |
| 30 |
* Finally, please use tabs and not spaces. The tab indent size should be 4 for all GeoDirectory code. |
| 31 |
|
| 32 |
At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary. |
| 33 |
|
| 34 |
# Additional Resources |
| 35 |
* [](https://userswp.io/documentation/UsersWP Developer's Codex](https://userswp.io/documentation/](https://userswp.io/documentation/) |
| 36 |
* [](https://help.github.com/General GitHub Documentation](https://help.github.com/](https://help.github.com/) |
| 37 |
* [](https://help.github.com/send-pull-requests/GitHub Pull Request documentation](https://help.github.com/send-pull-requests/](https://help.github.com/send-pull-requests/) |
| 38 |
* [](https://phpunit.de/manual/current/en/writing-tests-for-phpunit.htmlPHPUnit Tests Guide](https://phpunit.de/manual/current/en/writing-tests-for-phpunit.html](https://phpunit.de/manual/current/en/writing-tests-for-phpunit.html) |
