Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

59 lines (38 loc) · 2.99 KB
Raw

Contributing to react-native-ios-kit

Code of Conduct

We want this community to be friendly and respectful to each other. Please read the full text so that you can understand what actions will and will not be tolerated.

Development Process

The core team works directly on GitHub and all work is public.

Workflow and Pull Requests

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Before submitting a pull request, please make sure the following is done:

  1. Fork the repo and create your branch from master (a guide on how to fork a repository).
  2. We have a commit message convention:
    • fix - bug fixes
    • feature - new features, e.g. add GroupedList component
    • docs - code/structure refactor, e.g. new structure folder for components
    • refactor - changes into documentation, e.g. add usage example for Button
    • chore - tooling changes, e.g. change circle ci config
  3. Be sure to follow the specifics (design, name convention, etc) described in the iOS design docs.
  4. Default colors will be provided by the theme, if you find that there's something missing from the theme that might be beneficial for other components don't hesitate to add it to the theme.
  5. For any Text usage, use our components provided in the Typography folder.
  6. If your app depends on the theme always wrap you component with withTheme to get the theme as a prop.
  7. Have different usages of your component in the example app.
  8. Always make sure that your code passes eslint before opening a PR.
  9. If you've changed APIs, update the documentation.
  10. Make sure to provide an example usage for the component (check how others do it)]

Running the example

The example app uses Expo. You will need to install the Expo app for iOS to start developing.

After you're done, you can run yarn && yarn start in the example/ folder and scan the QR code to launch it on your device.

Working on documentation

We use docusaurus. If you want to make changes in documentation feel free to add/edit files inside /docs directory. For more information about creating docs with docusaurus see it's documentation.

Reporting New Issues

The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example.

How to Get in Touch

Code Conventions

We use Prettier with ESLint integration.

License

By contributing to react-native-ios-kit, you agree that your contributions will be licensed under its MIT license.