|
| 1 | +# Contributing to _PopMenu_ |
| 2 | + |
| 3 | +The following is a set of guidelines for contributing to _PopMenu_ on GitHub. |
| 4 | + |
| 5 | +> Thank you for considering making contribution to the project, this means a lot to me. |
| 6 | +
|
| 7 | +## I want to report a problem or ask a question |
| 8 | + |
| 9 | +Before submitting a new GitHub issue, please make sure to |
| 10 | + |
| 11 | +- Check out the [documentation](https://calicastle.github.io/PopMenu). |
| 12 | +- Read the usage guide on [the README](https://github.com/CaliCastle/PopMenu/#usage). |
| 13 | +- Search for [existing GitHub issues](https://github.com/CaliCastle/PopMenu/issues). |
| 14 | + |
| 15 | +If the above doesn't help, please [submit an issue](https://github.com/CaliCastle/PopMenu/issues) on GitHub. |
| 16 | + |
| 17 | +## I want to contribute to _PopMenu_ |
| 18 | + |
| 19 | +### Things to keep in mind |
| 20 | + |
| 21 | +- Please do not change the minimum iOS version |
| 22 | +- Always document new public methods and properties |
| 23 | + |
| 24 | +### Testing your local changes |
| 25 | + |
| 26 | +Before opening a pull request, please make sure your changes don't break things. |
| 27 | + |
| 28 | +- The framework and example project should build without warnings |
| 29 | +- The example project should run without issues. |
| 30 | + |
| 31 | +### Submitting the PR |
| 32 | + |
| 33 | +When the coding is done and you’ve finished testing your changes, you are ready to submit the PR to the [main repo](https://github.com/CaliCastle/PopMenu). Some best practices are: |
| 34 | + |
| 35 | +- Use a descriptive title |
| 36 | +- Link the issues that are related to your PR in the body |
| 37 | + |
| 38 | +## Code of Conduct |
| 39 | + |
| 40 | +Help us keep _BulletinBoard_ open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). |
| 41 | + |
| 42 | +## License |
| 43 | + |
| 44 | +This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file. |
0 commit comments