Skip to content

Commit

Permalink
update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Swati Goel <meet2swati@gmail.com>
  • Loading branch information
swatigoel committed Feb 23, 2024
1 parent 987b2d2 commit f5e8817
Showing 1 changed file with 24 additions and 34 deletions.
58 changes: 24 additions & 34 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,35 @@

Contributions are always welcome, no matter how large or small!

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).
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.
This guide will help you regarding various aspects like putting issues, contributing a feature, etc.

## Development workflow
## Code of Conduct
This project and everyone participating in it is governed by the [code of conduct](./CODE_OF_CONDUCT.md).

To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:

```sh
yarn
```
## Before Submitting a Pull Request

> 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.
> **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).
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.
**Before submitting your pull request** make sure the following requirements are fulfilled:

To start the packager:
- Fork the repository
- Create a branch from `develop`
- Prefer small pull requests focused on one change
- Check linting and format it
- Change necessary code for bug fix, a new feature
- Follow the pull request template when opening a pull request
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.

```sh
yarn example start
```
### Development workflow

To run the example app on Android:
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:

```sh
yarn example android
yarn
```

To run the example app on iOS:

```sh
yarn example ios
```
> 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.
Make sure your code passes TypeScript and ESLint. Run the following to verify:

Expand All @@ -53,10 +51,9 @@ Remember to add tests for your change if possible. Run the unit tests by:
yarn test
```

To edit the Objective-C or Swift files, open `example/ios/TuvaliExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-tuvali`.

To edit the Java or Kotlin files, open `example/android` in Android studio and find the source files at `react-native-tuvali` under `Android`.
To edit the Objective-C or Swift files, open `ios/` in XCode.

To edit the Java or Kotlin files, open `android/` in Android studio.

### Commit message convention

Expand Down Expand Up @@ -97,18 +94,11 @@ The `package.json` file contains various scripts for common tasks:
- `yarn typescript`: type-check files with TypeScript.
- `yarn lint`: lint files with ESLint.
- `yarn test`: run unit tests with Jest.
- `yarn example start`: start the Metro server for the example app.
- `yarn example android`: run the example app on Android.
- `yarn example ios`: run the example app on iOS.

### Sending a pull request

> **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).
## Reporting an issue

When you're sending a pull request:
Before submitting an issue, you need to make sure:

- Prefer small pull requests focused on one change.
- Verify that linters and tests are passing.
- Review the documentation to make sure it looks good.
- Follow the pull request template when opening a pull request.
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
- Kindly provide an adequate description and a clear title
- If possible, share a URL towards the repository in which action is failing

0 comments on commit f5e8817

Please sign in to comment.