Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 3.56 KB
Raw

Contributing to React Native NetInfo

Development Process

All work on React Native NetInfo happens directly on GitHub. Contributors send pull requests which go through a review process.

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

  1. Fork the repo and create your branch from master (a guide on how to fork a repository).
  2. Run yarn or npm install to install all required dependencies.
    1. For Apple-related changes, you also need to install the Pods - cd example/ios && pod install && cd ../macos && pod install
    2. For windows-related changes TBD
  3. Now you are ready to make your changes!

Tests & Verifications

Currently we use flow for typechecking, eslint with prettier for linting and formatting the code, and jest for unit testing. All of these are run on CircleCI for all opened pull requests, but you should use them locally when making changes.

  • yarn test: Run all tests and validations.
    • yarn validate:eslint: Run eslint.
    • yarn validate:eslint --fix: Run eslint and automatically fix issues. This is useful for correcting code formatting.
    • yarn validate:typescript: Run typescript typechecking.
    • yarn test:jest: Run unit tests with jest.
  • You should verify that the example app demonstrates correct functionality. If you added a feature, also add a demonstration of the new feature
    • yarn start:android - run the example app in android to demonstrate functionality
    • yarn start:ios - run the example app in ios to demonstrate functionality
    • yarn start:macos - run the example app in macos to demonstrate functionality
    • yarn start:windows - run the example app in windows to demonstrate functionality
    • yarn start:web - run the example web app on http://localhost:3000 to demonstrate functionality (currently requires Node v16, v18+ is not working)
  • yarn test:e2e:macos: Run the end-to-end tests for macOS.

Sending a pull request

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify that all tests and validations are passing.
  • Follow the pull request template when opening a pull request.

Commit message convention

We prefix our commit messages with one of the following to signify the kind of change:

  • build: Changes that affect the build system or external dependencies.
  • ci, chore: Changes to our CI configuration files and scripts.
  • docs: Documentation only changes.
  • feat: A new feature.
  • fix: A bug fix.
  • perf: A code change that improves performance.
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • style: Changes that do not affect the meaning of the code.
  • test: Adding missing tests or correcting existing tests.

Release process

We use Semantic Release to automatically release new versions of the library when changes are merged into master. Using the commit message convention described above, it will detect if we need to release a patch, minor, or major version of the library.

Reporting issues

You can report issues on our bug tracker. Please search for existing issues and follow the issue template when opening an issue.

License

By contributing to React Native NetInfo, you agree that your contributions will be licensed under the MIT license.