Skip to content

Latest commit

 

History

History
27 lines (14 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

27 lines (14 loc) · 1.63 KB

Loadability Contribution Guide

Adapted from the Plot Contribution Guide

Welcome to the Loadability Contribution Guide, which aims to give you all the information you need to contribute to Loadability. Thank you for your interest in contributing to this project!

Bugs, feature requests and support

I found a bug, how do I report it?

If you find a bug, such as loading or caching not working correctly, please file a detailed Github Issue containing all of the information necessary to reproduce the bug. This helps us to quickly understand the bug and triage it.

I have an idea for a feature request

Awesome! You can either create a Github Issue describing your idea and how it would improve the project, or create a Pull Request with your feature. Creating a Pull Request contributes to the project and makes it more likely your idea will be added!

I have a question

Please make sure you read the documentation (inline in the source files) and README carefully. If your question is still not answered, file a Github Issue detailing your question and what steps you took already.

Project structure

Loadability is structured in the default way for Swift Packages. Source code is in the Source/Loadability directory, with each type in a separate file. The library has extensive documentation; please ensure that additive changes have high-quality documentation.

Conclusion

Hopefully this document helped you better understand how Loadability is structured and the best way to get help or contribute to the project. Thanks again for the interest!