<The Development Workflow
The standard development on CocoaPods happens like so:
- Set up your development environment with Rainforest.
- Pick up an Issue . See issue classifications explained below
- Check the CONTRIBUTING requirements.
- Make a pull request.
<Picking Up Issues
- Defect: These are known bugs. The issue should also contain steps to reproduce. Feel free to fix these and submit a pull request.
- Enhancement: These are planned enhancements that have not been picked up yet. If you would like to work on one, please add a comment that you are doing so.
- Discussion: These are issues that can be non-issues, and encompass best practices, or plans for the future.
- Quick: These are small issues, that should be able to be fixed quickly. Normally these issues don't stay around for very long.
- To check: These issues may not be reproducible, or have not been vetted by a team member.
- Workaround known: These issues have had their solutions discussed, but have yet to be implemented.
- Easy First Step These issues are great issues to get started with. They tend to stick around for a while. We want people to feel like there's always somewhere you can start.
Making the Pull Request
Before submitting your pull request, please do the following:
rake specand make sure all the tests pass. If you are adding new commands or features, they must include tests. If you are changing functionality, update the tests if you need to.
- Add a note to the
CHANGELOGdescribing what you changed.
- Make your pull request. If it is related to an issue, add a link to the issue in the description.
CocoaPods favours small methods and many classes as convention. It is encouraged that methods are as small as possible, both for code reuse, and for ease of reading.