@baby-journey/rn-segmented-progress-bar 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/.editorconfig +15 -0
  2. package/.gitattributes +3 -0
  3. package/.gitignore +70 -0
  4. package/.nvmrc +1 -0
  5. package/.watchmanconfig +1 -0
  6. package/.yarnrc +3 -0
  7. package/CODE_OF_CONDUCT.md +133 -0
  8. package/CONTRIBUTING.md +116 -0
  9. package/README.md +83 -4
  10. package/babel.config.js +3 -0
  11. package/baby-journey-rn-segmented-progress-bar-v0.1.0.tgz +0 -0
  12. package/docs/CODE_OF_CONDUCT.md +44 -0
  13. package/docs/CONTRIBUTING.md +95 -0
  14. package/docs/pull_request_template.md +28 -0
  15. package/example/.expo/README.md +8 -0
  16. package/example/.expo/devices.json +3 -0
  17. package/example/App.js +1 -0
  18. package/example/app.json +33 -0
  19. package/example/assets/adaptive-icon.png +0 -0
  20. package/example/assets/favicon.png +0 -0
  21. package/example/assets/icon.png +0 -0
  22. package/example/assets/splash.png +0 -0
  23. package/example/babel.config.js +22 -0
  24. package/example/metro.config.js +38 -0
  25. package/example/package.json +26 -0
  26. package/example/src/App.tsx +41 -0
  27. package/example/tsconfig.json +6 -0
  28. package/example/webpack.config.js +25 -0
  29. package/example/yarn.lock +10555 -0
  30. package/lefthook.yml +16 -0
  31. package/lib/commonjs/helpers/index.js +4 -4
  32. package/lib/commonjs/helpers/index.js.map +1 -1
  33. package/lib/commonjs/index.js +29 -35
  34. package/lib/commonjs/index.js.map +1 -1
  35. package/lib/module/helpers/index.js +4 -4
  36. package/lib/module/helpers/index.js.map +1 -1
  37. package/lib/module/index.js +29 -35
  38. package/lib/module/index.js.map +1 -1
  39. package/lib/typescript/helpers/index.d.ts +1 -1
  40. package/lib/typescript/helpers/index.d.ts.map +1 -1
  41. package/lib/typescript/index.d.ts +7 -10
  42. package/lib/typescript/index.d.ts.map +1 -1
  43. package/package.json +9 -5
  44. package/scripts/bootstrap.js +29 -0
  45. package/src/__tests__/helper/index.test.js +92 -0
  46. package/src/__tests__/index.test.js +28 -0
  47. package/src/helpers/index.ts +4 -5
  48. package/src/index.tsx +45 -54
  49. package/tsconfig.build.json +5 -0
  50. package/tsconfig.json +28 -0
  51. package/yarn.lock +9933 -0
package/.editorconfig ADDED
@@ -0,0 +1,15 @@
1
+ # EditorConfig helps developers define and maintain consistent
2
+ # coding styles between different editors and IDEs
3
+ # editorconfig.org
4
+
5
+ root = true
6
+
7
+ [*]
8
+
9
+ indent_style = space
10
+ indent_size = 2
11
+
12
+ end_of_line = lf
13
+ charset = utf-8
14
+ trim_trailing_whitespace = true
15
+ insert_final_newline = true
package/.gitattributes ADDED
@@ -0,0 +1,3 @@
1
+ *.pbxproj -text
2
+ # specific for windows script files
3
+ *.bat text eol=crlf
package/.gitignore ADDED
@@ -0,0 +1,70 @@
1
+ # OSX
2
+ #
3
+ .DS_Store
4
+
5
+ # XDE
6
+ .expo/
7
+
8
+ # VSCode
9
+ .vscode/
10
+ jsconfig.json
11
+
12
+ # Xcode
13
+ #
14
+ build/
15
+ *.pbxuser
16
+ !default.pbxuser
17
+ *.mode1v3
18
+ !default.mode1v3
19
+ *.mode2v3
20
+ !default.mode2v3
21
+ *.perspectivev3
22
+ !default.perspectivev3
23
+ xcuserdata
24
+ *.xccheckout
25
+ *.moved-aside
26
+ DerivedData
27
+ *.hmap
28
+ *.ipa
29
+ *.xcuserstate
30
+ project.xcworkspace
31
+
32
+ # Android/IJ
33
+ #
34
+ .classpath
35
+ .cxx
36
+ .gradle
37
+ .idea
38
+ .project
39
+ .settings
40
+ local.properties
41
+ android.iml
42
+
43
+ # Cocoapods
44
+ #
45
+ example/ios/Pods
46
+
47
+ # Ruby
48
+ example/vendor/
49
+
50
+ # node.js
51
+ #
52
+ node_modules/
53
+ npm-debug.log
54
+ yarn-debug.log
55
+ yarn-error.log
56
+
57
+ # BUCK
58
+ buck-out/
59
+ \.buckd/
60
+ android/app/libs
61
+ android/keystores/debug.keystore
62
+
63
+ # Expo
64
+ .expo/
65
+
66
+ # Turborepo
67
+ .turbo/
68
+
69
+ # generated by bob
70
+ lib/
package/.nvmrc ADDED
@@ -0,0 +1 @@
1
+ 16.18.1
@@ -0,0 +1 @@
1
+ {}
package/.yarnrc ADDED
@@ -0,0 +1,3 @@
1
+ # Override Yarn command so we can automatically setup the repo on running `yarn`
2
+
3
+ yarn-path "scripts/bootstrap.js"
@@ -0,0 +1,133 @@
1
+
2
+ # Contributor Covenant Code of Conduct
3
+
4
+ ## Our Pledge
5
+
6
+ We as members, contributors, and leaders pledge to make participation in our
7
+ community a harassment-free experience for everyone, regardless of age, body
8
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
9
+ identity and expression, level of experience, education, socio-economic status,
10
+ nationality, personal appearance, race, caste, color, religion, or sexual
11
+ identity and orientation.
12
+
13
+ We pledge to act and interact in ways that contribute to an open, welcoming,
14
+ diverse, inclusive, and healthy community.
15
+
16
+ ## Our Standards
17
+
18
+ Examples of behavior that contributes to a positive environment for our
19
+ community include:
20
+
21
+ * Demonstrating empathy and kindness toward other people
22
+ * Being respectful of differing opinions, viewpoints, and experiences
23
+ * Giving and gracefully accepting constructive feedback
24
+ * Accepting responsibility and apologizing to those affected by our mistakes,
25
+ and learning from the experience
26
+ * Focusing on what is best not just for us as individuals, but for the overall
27
+ community
28
+
29
+ Examples of unacceptable behavior include:
30
+
31
+ * The use of sexualized language or imagery, and sexual attention or advances of
32
+ any kind
33
+ * Trolling, insulting or derogatory comments, and personal or political attacks
34
+ * Public or private harassment
35
+ * Publishing others' private information, such as a physical or email address,
36
+ without their explicit permission
37
+ * Other conduct which could reasonably be considered inappropriate in a
38
+ professional setting
39
+
40
+ ## Enforcement Responsibilities
41
+
42
+ Community leaders are responsible for clarifying and enforcing our standards of
43
+ acceptable behavior and will take appropriate and fair corrective action in
44
+ response to any behavior that they deem inappropriate, threatening, offensive,
45
+ or harmful.
46
+
47
+ Community leaders have the right and responsibility to remove, edit, or reject
48
+ comments, commits, code, wiki edits, issues, and other contributions that are
49
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
50
+ decisions when appropriate.
51
+
52
+ ## Scope
53
+
54
+ This Code of Conduct applies within all community spaces, and also applies when
55
+ an individual is officially representing the community in public spaces.
56
+ Examples of representing our community include using an official e-mail address,
57
+ posting via an official social media account, or acting as an appointed
58
+ representative at an online or offline event.
59
+
60
+ ## Enforcement
61
+
62
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
63
+ reported to the community leaders responsible for enforcement at
64
+ [INSERT CONTACT METHOD].
65
+ All complaints will be reviewed and investigated promptly and fairly.
66
+
67
+ All community leaders are obligated to respect the privacy and security of the
68
+ reporter of any incident.
69
+
70
+ ## Enforcement Guidelines
71
+
72
+ Community leaders will follow these Community Impact Guidelines in determining
73
+ the consequences for any action they deem in violation of this Code of Conduct:
74
+
75
+ ### 1. Correction
76
+
77
+ **Community Impact**: Use of inappropriate language or other behavior deemed
78
+ unprofessional or unwelcome in the community.
79
+
80
+ **Consequence**: A private, written warning from community leaders, providing
81
+ clarity around the nature of the violation and an explanation of why the
82
+ behavior was inappropriate. A public apology may be requested.
83
+
84
+ ### 2. Warning
85
+
86
+ **Community Impact**: A violation through a single incident or series of
87
+ actions.
88
+
89
+ **Consequence**: A warning with consequences for continued behavior. No
90
+ interaction with the people involved, including unsolicited interaction with
91
+ those enforcing the Code of Conduct, for a specified period of time. This
92
+ includes avoiding interactions in community spaces as well as external channels
93
+ like social media. Violating these terms may lead to a temporary or permanent
94
+ ban.
95
+
96
+ ### 3. Temporary Ban
97
+
98
+ **Community Impact**: A serious violation of community standards, including
99
+ sustained inappropriate behavior.
100
+
101
+ **Consequence**: A temporary ban from any sort of interaction or public
102
+ communication with the community for a specified period of time. No public or
103
+ private interaction with the people involved, including unsolicited interaction
104
+ with those enforcing the Code of Conduct, is allowed during this period.
105
+ Violating these terms may lead to a permanent ban.
106
+
107
+ ### 4. Permanent Ban
108
+
109
+ **Community Impact**: Demonstrating a pattern of violation of community
110
+ standards, including sustained inappropriate behavior, harassment of an
111
+ individual, or aggression toward or disparagement of classes of individuals.
112
+
113
+ **Consequence**: A permanent ban from any sort of public interaction within the
114
+ community.
115
+
116
+ ## Attribution
117
+
118
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119
+ version 2.1, available at
120
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121
+
122
+ Community Impact Guidelines were inspired by
123
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124
+
125
+ For answers to common questions about this code of conduct, see the FAQ at
126
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127
+ [https://www.contributor-covenant.org/translations][translations].
128
+
129
+ [homepage]: https://www.contributor-covenant.org
130
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131
+ [Mozilla CoC]: https://github.com/mozilla/diversity
132
+ [FAQ]: https://www.contributor-covenant.org/faq
133
+ [translations]: https://www.contributor-covenant.org/translations
@@ -0,0 +1,116 @@
1
+ # Contributing
2
+
3
+ Contributions are always welcome, no matter how large or small!
4
+
5
+ We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md).
6
+
7
+ ## Development workflow
8
+
9
+ To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
10
+
11
+ ```sh
12
+ yarn
13
+ ```
14
+
15
+ > While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
16
+
17
+ While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
18
+
19
+ To start the packager:
20
+
21
+ ```sh
22
+ yarn example start
23
+ ```
24
+
25
+ To run the example app on Android:
26
+
27
+ ```sh
28
+ yarn example android
29
+ ```
30
+
31
+ To run the example app on iOS:
32
+
33
+ ```sh
34
+ yarn example ios
35
+ ```
36
+
37
+ To run the example app on Web:
38
+
39
+ ```sh
40
+ yarn example web
41
+ ```
42
+
43
+ Make sure your code passes TypeScript and ESLint. Run the following to verify:
44
+
45
+ ```sh
46
+ yarn typecheck
47
+ yarn lint
48
+ ```
49
+
50
+ To fix formatting errors, run the following:
51
+
52
+ ```sh
53
+ yarn lint --fix
54
+ ```
55
+
56
+ Remember to add tests for your change if possible. Run the unit tests by:
57
+
58
+ ```sh
59
+ yarn test
60
+ ```
61
+
62
+
63
+ ### Commit message convention
64
+
65
+ We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
66
+
67
+ - `fix`: bug fixes, e.g. fix crash due to deprecated method.
68
+ - `feat`: new features, e.g. add new method to the module.
69
+ - `refactor`: code refactor, e.g. migrate from class components to hooks.
70
+ - `docs`: changes into documentation, e.g. add usage example for the module..
71
+ - `test`: adding or updating tests, e.g. add integration tests using detox.
72
+ - `chore`: tooling changes, e.g. change CI config.
73
+
74
+ Our pre-commit hooks verify that your commit message matches this format when committing.
75
+
76
+ ### Linting and tests
77
+
78
+ [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
79
+
80
+ We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
81
+
82
+ Our pre-commit hooks verify that the linter and tests pass when committing.
83
+
84
+ ### Publishing to npm
85
+
86
+ We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
87
+
88
+ To publish new versions, run the following:
89
+
90
+ ```sh
91
+ yarn release
92
+ ```
93
+
94
+ ### Scripts
95
+
96
+ The `package.json` file contains various scripts for common tasks:
97
+
98
+ - `yarn bootstrap`: setup project by installing all dependencies and pods.
99
+ - `yarn typecheck`: type-check files with TypeScript.
100
+ - `yarn lint`: lint files with ESLint.
101
+ - `yarn test`: run unit tests with Jest.
102
+ - `yarn example start`: start the Metro server for the example app.
103
+ - `yarn example android`: run the example app on Android.
104
+ - `yarn example ios`: run the example app on iOS.
105
+
106
+ ### Sending a pull request
107
+
108
+ > **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
109
+
110
+ When you're sending a pull request:
111
+
112
+ - Prefer small pull requests focused on one change.
113
+ - Verify that linters and tests are passing.
114
+ - Review the documentation to make sure it looks good.
115
+ - Follow the pull request template when opening a pull request.
116
+ - For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
package/README.md CHANGED
@@ -1,6 +1,85 @@
1
- # rn-segmented-progress-bar
1
+ # React Native Segmented Progress Bar
2
2
 
3
- This is the official repository for segmented progress bar component.
4
- Work in progress
3
+ A React Native progress bar that animates and draws the progress in a circular path. The progress bar indicator can move in number of segments to imply the percentage of the progress.
5
4
 
6
- Test
5
+ The following are customizable:
6
+ - The circular track color
7
+ - Indicator color
8
+ - Number of segments. PS: The maximum number of segments is 10
9
+ - Center element can be customized (e.g. you can pass a component that will be rendered)
10
+ - Stroke width of a single segment
11
+ - Radius of the component
12
+
13
+ ## Installing
14
+
15
+ With npm
16
+
17
+ ```
18
+ npm install rn-segmented-progress-bar --save
19
+ ```
20
+
21
+ With yarn
22
+
23
+ ```
24
+ yarn add rn-segmented-progress-bar
25
+ ```
26
+
27
+ ## Usage
28
+
29
+ ```javascript
30
+ import RNSegmentedProgressBar from 'rn-segmented-progress-bar';
31
+
32
+ <RNSegmentedProgressBar
33
+ ref={segmentedProgressBarRef}
34
+ radius={114}
35
+ strokeWidth={14}
36
+ segmentsGap={30}
37
+ segments={4}
38
+ />
39
+
40
+ ```
41
+
42
+ ## Examples
43
+
44
+ 1. Single circle
45
+
46
+ ![1part](https://user-images.githubusercontent.com/1639119/215097139-4dacc33d-f2c7-4a2b-83ad-f856ec822e47.gif)
47
+
48
+ 2. Mutiple segments
49
+
50
+ ![noind](https://user-images.githubusercontent.com/1639119/215097549-262da352-83d5-45f3-8f81-6abcaaea6b72.gif)
51
+
52
+ 3. Multiple segments with progress circle
53
+
54
+ ![3part](https://user-images.githubusercontent.com/1639119/215097606-b4c8139c-d949-4e98-ab9d-787cf89424bb.gif)
55
+
56
+ ## Props
57
+
58
+ | Prop | Description | Type | Default Value | Required |
59
+ | :--------------------------:|:--------------------------------------------------------------------------------------|:-----------------------------:|:-------------------:|:--------:|
60
+ | radius | Radius of the progress indicator | Number | 100 | True |
61
+ | strokeWidth |Thickness of the circular track | Number | 10 | True |
62
+ | tintColor | Color of the circular track | rgba | #FFEDE1 | False |
63
+ | fillColor | Color of the progress indicator | rgba | #F39E93 | False |
64
+ | segments | Number of segments | Number | 3 | False |
65
+ | segmentsGap | Gap between segments | Number | 0 | False |
66
+ | centerComponent | A component used to display the percentage of the progress | React.ReactNode | - | False |
67
+ | indicator | A colored progression path which shows the completed percentage | Object. Refer IndicatorProps interface given below. | - | False |
68
+
69
+ ```
70
+ Indicator interface:
71
+
72
+ interface IndicatorProps {
73
+ show?: boolean;
74
+ radius?: number;
75
+ strokeWidth?: number;
76
+ color?: string;
77
+ }
78
+ ```
79
+
80
+
81
+ ## [License](https://github.com/baby-journey/rn-segmented-progress-bar/blob/main/LICENSE)
82
+
83
+ ## Author
84
+
85
+ * **BabyJourney** - [BabyJourney](https://github.com/baby-journey/rn-segmented-progress-bar)
@@ -0,0 +1,3 @@
1
+ module.exports = {
2
+ presets: ['module:metro-react-native-babel-preset'],
3
+ };
@@ -0,0 +1,44 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ ## Our Standards
8
+
9
+ Examples of behavior that contributes to creating a positive environment include:
10
+
11
+ Using welcoming and inclusive language
12
+ Being respectful of differing viewpoints and experiences
13
+ Gracefully accepting constructive criticism
14
+ Focusing on what is best for the community
15
+ Showing empathy towards other community members
16
+ Examples of unacceptable behavior by participants include:
17
+
18
+ The use of sexualized language or imagery and unwelcome sexual attention or advances
19
+ Trolling, insulting/derogatory comments, and personal or political attacks
20
+ Public or private harassment
21
+ Publishing others' private information, such as a physical or electronic address, without explicit permission
22
+ Other conduct which could reasonably be considered inappropriate in a professional setting
23
+
24
+ ## Our Responsibilities
25
+
26
+ Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
27
+
28
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
29
+
30
+ ## Scope
31
+
32
+ This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
33
+
34
+ ## Enforcement
35
+
36
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at dev@babyjourney.se. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
37
+
38
+ Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
39
+
40
+ ## Attribution
41
+
42
+ This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
43
+
44
+ For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
@@ -0,0 +1,95 @@
1
+ # Welcome to GitHub docs contributing guide <!-- omit in toc -->
2
+
3
+ Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:.
4
+
5
+ Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
6
+
7
+ In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
8
+
9
+ Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
10
+
11
+ ## New contributor guide
12
+
13
+ To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
14
+
15
+ - [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
16
+ - [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
17
+ - [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
18
+ - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
19
+
20
+
21
+ ## Getting started
22
+
23
+ To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md) :confetti_ball:. For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md).
24
+
25
+ Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
26
+
27
+ ### Issues
28
+
29
+ #### Create a new issue
30
+
31
+ If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).
32
+
33
+ #### Solve an issue
34
+
35
+ Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
36
+
37
+ ### Make Changes
38
+
39
+ #### Make changes in the UI
40
+
41
+ Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
42
+
43
+ <img src="./assets/images/contribution_cta.png" width="300" height="150" />
44
+
45
+ #### Make changes in a codespace
46
+
47
+ For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)."
48
+
49
+ #### Make changes locally
50
+
51
+ 1. Fork the repository.
52
+ - Using GitHub Desktop:
53
+ - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
54
+ - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
55
+
56
+ - Using the command line:
57
+ - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
58
+
59
+ 2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](contributing/development.md).
60
+
61
+ 3. Create a working branch and start with your changes!
62
+
63
+ ### Commit your update
64
+
65
+ Commit the changes once you are happy with them. Don't forget to [self-review](/contributing/self-review.md) to speed up the review process:zap:.
66
+
67
+ ### Pull Request
68
+
69
+ When you're finished with the changes, create a pull request, also known as a PR.
70
+ - Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
71
+ - Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
72
+ - Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
73
+ Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
74
+ - We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
75
+ - As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
76
+ - If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
77
+
78
+ ### Your PR is merged!
79
+
80
+ Congratulations :tada::tada: The GitHub team thanks you :sparkles:.
81
+
82
+ Once your PR is merged, your contributions will be publicly visible on the [GitHub docs](https://docs.github.com/en).
83
+
84
+ Now that you are part of the GitHub docs community, see how else you can [contribute to the docs](/contributing/types-of-contributions.md).
85
+
86
+ ## Windows
87
+
88
+ This site can be developed on Windows, however a few potential gotchas need to be kept in mind:
89
+
90
+ 1. Regular Expressions: Windows uses `\r\n` for line endings, while Unix-based systems use `\n`. Therefore, when working on Regular Expressions, use `\r?\n` instead of `\n` in order to support both environments. The Node.js [`os.EOL`](https://nodejs.org/api/os.html#os_os_eol) property can be used to get an OS-specific end-of-line marker.
91
+ 2. Paths: Windows systems use `\` for the path separator, which would be returned by `path.join` and others. You could use `path.posix`, `path.posix.join` etc and the [slash](https://ghub.io/slash) module, if you need forward slashes - like for constructing URLs - or ensure your code works with either.
92
+ 3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write [scripts](/script) in JavaScript instead of Bash.
93
+ 4. Filename too long error: There is a 260 character limit for a filename when Git is compiled with `msys`. While the suggestions below are not guaranteed to work and could cause other issues, a few workarounds include:
94
+ - Update Git configuration: `git config --system core.longpaths true`
95
+ - Consider using a different Git client on Windows
@@ -0,0 +1,28 @@
1
+ * **Please check if the PR fulfills these requirements**
2
+
3
+ - [ ] Your changes are in a separate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/signin-issue` or `feature/issue-templates`.
4
+ - [ ] Tests for the changes have been added (for bug fixes/features). `yarn test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`).
5
+ - [ ] Docs have been added / updated (for bug fixes / features)
6
+ - [ ] Make sure that your PR is not a duplicate.
7
+ - [ ] The commit message follows Conventional Commits Refer: https://www.conventionalcommits.org/en/v1.0.0/
8
+ - [ ] Give a descriptive title to your PR.
9
+ - [ ] Describe your changes.
10
+ - [ ] Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
11
+
12
+
13
+ * **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
14
+
15
+
16
+ * **What is the current behavior?** (You can also link to an open issue here)
17
+
18
+
19
+ * **What is the new behavior (if this is a feature change)?**
20
+
21
+
22
+ * **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
23
+
24
+
25
+ * **Other information**:
26
+
27
+
28
+ IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
@@ -0,0 +1,8 @@
1
+ > Why do I have a folder named ".expo" in my project?
2
+ The ".expo" folder is created when an Expo project is started using "expo start" command.
3
+ > What do the files contain?
4
+ - "devices.json": contains information about devices that have recently opened this project. This is used to populate the "Development sessions" list in your development builds.
5
+ - "settings.json": contains the server configuration that is used to serve the application manifest.
6
+ > Should I commit the ".expo" folder?
7
+ No, you should not share the ".expo" folder. It does not contain any information that is relevant for other developers working on the project, it is specific to your machine.
8
+ Upon project creation, the ".expo" folder is already added to your ".gitignore" file.
@@ -0,0 +1,3 @@
1
+ {
2
+ "devices": []
3
+ }
package/example/App.js ADDED
@@ -0,0 +1 @@
1
+ export { default } from './src/App';