Add a Contributing markdown file #555
Merged
+145
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Saadnajmi
requested review from
FalseLobster,
HeyImChris,
JasonVMo,
chiuam,
ejlayne and
harrieshin
harrieshin
reviewed
Nov 6, 2020
JasonVMo
previously requested changes
Nov 9, 2020
Contributor
JasonVMo
left a comment
JasonVMo
left a comment
There was a problem hiding this comment.
I think it is great to add a full on contributing.md (or at least getting that started). This is written from the perspective of adding apple components while the contributing.md file is for the entire repository so this likely needs to be re-authored to have a more top down structure.
The information is great, I would just re-organize it slightly. E.g. something like:
- understanding the repo structure
- understanding the framework
- adding native code
- adding new apple components
It's fine to have a section be incomplete or TBD to start, but that way everything fits together better and it is easier to fill in additional data.
Collaborator
Author
|
@JasonVMo since there's quite a bit of documentation already written in the repo for the original compose framework, I'm assuming that any restructuring I do should only be additive, and not be removing any links to existing documentation? Otherwise, that sounds completely reasonable =) |
Collaborator
Author
I tried to follow this quite heavily, where every H2 header is one of the four Jason listed, with one new "Creating a new component" section. |
Saadnajmi
changed the title
HeyImChris
previously requested changes
Feb 2, 2021
harrieshin
reviewed
Apr 19, 2021
harrieshin
approved these changes
Apr 19, 2021
…nto apple-documentation
HeyImChris
approved these changes
Apr 26, 2021
chiuam
pushed a commit
to chiuam/fluentui-react-native
that referenced
this pull request
Apr 28, 2021
* Initial Commit * Restructuring * Rewrite Slots summary * Update Guide based on feedback * More fixes * Update from PR feedback
HeyImChris
pushed a commit
that referenced
this pull request
May 11, 2021
* prototype * style gradient * componentize shimmer * prototype * style gradient * Android theme (#613) * initial android theme * mapped a lot of colors, updated readme, added to fluent-tester-app * Change files * removed unneccessary dependencies * added android typography * updated versioning, removed apple specific changes * making android-theme default for the platform * update fluent-tester dependency version... * resolving comments... * resolving more comments... Co-authored-by: Tushar Masane <tushar@AZH-NT-02.middleeast.corp.microsoft.com> * 📦 applying package updates ***NO_CI*** * Add repository link for @fluentui/react-native (#649) * Change files * Remove change file * Add repository link * Change files * Add a nil check to Avatar image property (#650) * Add a nil check to AvatarData image * Change files * Update Radio Button focus border style to be WCAG 2.1 compliant (#653) * Change files * Remove change file * Update radio button focus border style * Change files * Add the rainbow gradient border image test case to experimental avatar (#654) * Add the rainbow gradient test case * Change files * Add apple theme static libraries to NuGet package (#655) * Add apple theme static libraries to NuGet, add NuGet Publish PR job * Fix path in nuspec * Comment out NugetPublish PR Job * Fix npm publish pipeline (hopefully) (#656) * fix typos in android-theme * Change files * 📦 applying package updates ***NO_CI*** * Android Svg Support (#652) * added svg, transformer to android * base64 svgs do not load, font files do not link * Change files * bump package versions manually * Change files * upgrade react-native-svg * Change files * revert 'bump package versions manually' * Change files * 📦 applying package updates ***NO_CI*** * Fix typo in nuspec (#659) * Fix typo in nuspec * Comment out NuGet Publish again * Add Icon support for macOS (#645) * Add macOS support * Add link to issue regarding direct SVG imports * Replace react-native-svg with @microsoft/react-native-svg-desktop * Use react-native-svg now that it supports macOS * Upgrade react-native-svg to 12.1.1-0 everywhere * Update macos podfile * Change files * 📦 applying package updates ***NO_CI*** * chore: `rnx-start` is deprecated (#660) `rnx-start` is being removed because it currently does not provide any value over vanilla `react-native start`. See microsoft/rnx-kit#139 * Fix more typos in the nuspec (#661) * Fix typos, uncomment pipeline * comment out pipeline again * Revamp Android ThemePicker (#664) * updated themepicker for android * Change files * add correct picker... * ignore rn-picker depcheck... * separated android themepicker... * added dropdown styles... * add types for dropdown.. * Add a Contributing markdown file (#555) * Initial Commit * Restructuring * Rewrite Slots summary * Update Guide based on feedback * More fixes * Update from PR feedback * Add RNSVG dependency to Icon and update RNSVG version throughout (#668) * Add button icon tests specific to win32 * Change files * Change files * Add dependency to rnsvg * Add RNSVG dependency to ios and mac * Remove rnsvg dep from ios and macos due to failed depcheck * Add rnsvg to ios and macos againt but also add to ignores for depcheck * Add explicit react-native-svg dependency to FURN Icon (#666) * Add direct dependency on RNSVG in FURN Icon * Change files * Update yarn.lock with react-native-svg 12.1.1 * componentize shimmer * move shimmer to experimental * create slots for shapes * revamp shimmer slots * implement shimmerElement to group sub-elements * Change files * add shimmer to android and accessibility support * use useRef hook and union types * remove rect & circle slots * documentation Co-authored-by: Tushar Anil Masane <tamasane@gmail.com> Co-authored-by: Tushar Masane <tushar@AZH-NT-02.middleeast.corp.microsoft.com> Co-authored-by: UI-Fabric-RN-Bot <uifrnbot@microsoft.com> Co-authored-by: Krystal Siler <krsiler@microsoft.com> Co-authored-by: Saad Najmi <saadnajmi2@gmail.com> Co-authored-by: Adam Gleitman <adam.gleitman@gmail.com> Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com> Co-authored-by: warren-ms <63264034+warren-ms@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Platforms Impacted
Description of changes
I wrote a guide internally for my team to create new apple platform specific components. I would like to extend it to a full CONTRIBUTING.MD for the whole repo, and move the apple specfic sections down to make it more general.
This PR has considered (when applicable):