Getting Started
There are lots of ways to get involved with Library Simplified. Before you start, take a look at our current priorities
- Review our Product Backlog.
- Check out our roadmap issues and overall goals.
- Take a look at the issues in the specific Library Simplified repository that you're interested in working on.
...
- Let us know what you're going to work on -- before you spend a lot of time on it. Assign an issue to yourself on GitHub and/or reach out
...
Server
Mobile
iOS
This codebase follows Google's Objective-C Style Guide including the use of two-space indentation. Both Objective-C and Swift may be used for new code.
The primary services/singletons within the program are as follows:
NYPLAccount
NYPLBookCoverRegistry
(used directly only byNYPLBookRegistry
)NYPLBookRegistry
NYPLConfiguration
NYPLKeychain
NYPLMyBooksDownloadCenter
All of the above contain appropriate documentation in the header files.
The rest of the program follows Apple's usual pattern of passive views, relatively passive models, and one-off controllers for integrating everything. Immutability is preferred wherever possible.
Android
- via #Development on Slack.
Web
Web Applications include:
Community Engineering Lead: TBD
Steps to contribute code
Server Code Contribution Steps
Step 1 - Let us now! Contact us on #Development on Slack
Info | ||
---|---|---|
| ||
This means we know about your work as soon as possible. We can help you fit it into our product roadmap, and we can help with implementation details and with writing test cases. |
Step 2 - Clone Repository. Pull from Master.
Step 3 - Push Code and Unit Tests
Step 4 - Make Pull Request - You must select a reviewer as part of your PR to have your code reviewed.
Note | ||
---|---|---|
| ||
You code MUST have test cases included to be approved. For help reach out via Slack. |
Mobile Code Contributions Steps
Step 1 Contact us on Slack and join #mobile-development on Slack
Step 2 Read an follow platform specific guidelines at For Mobile Developers
...