Create CONTRIBUTING.md #30
Conversation
| Thank you for your interest in contributing to our project! <3 Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community. Please read through these guidelines carefully before submitting a PR or issue and let us know if it's not up-to-date (or even better, submit a PR with your corrections ;)). | ||
|
|
||
| - [Our History and Ethos](#our-history-and-ethos) | ||
| - [Our Design](#our-design) |
There was a problem hiding this comment.
Android & iOS do this differently.
Android does not include these sections.
I reviewed other third-party contributing guides, and they generally do not include this type of content. And also in the interest of keeping the guide brief, I omitted this content for our guide.
I suggest that all Amplify platforms move this content to an ETHOS.md or PHILOSOPHY.md. We could reference it with a one line statement from both the README.md and the CONTRIBUTING.md:
For background on Amplify's design philosophy see (external resource).
|
|
||
| @TODO | ||
|
|
||
| #### Packages inside Amplify JS |
There was a problem hiding this comment.
| #### Packages inside Amplify JS | |
| #### Packages inside Amplify Flutter |
| @TODO | ||
|
|
||
| #### Packages inside Amplify JS | ||
|
|
There was a problem hiding this comment.
We should explain what the packages are for. Since there a pattern of _interface vs. not, perhaps the best way to do this is with a leading paragraph:
_interfacepackages (do what), while the others provide an implementation. Currently, Amplify Flutter supports Authentication and Analytics. Both functionalities require the core module (for purpose).
Co-authored-by: Jameson Williams <jhwill@amazon.com>
Co-authored-by: Jameson Williams <jhwill@amazon.com>
Co-authored-by: Jameson Williams <jhwill@amazon.com>
Co-authored-by: Jameson Williams <jhwill@amazon.com>
Co-authored-by: Jameson Williams <jhwill@amazon.com>
Co-authored-by: Jameson Williams <jhwill@amazon.com>
Co-authored-by: Jameson Williams <jhwill@amazon.com>
[ci skip]
Start contributing guide