Skip to content

Commit

Permalink
--amend
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 26, 2024
1 parent f5e8817 commit e85b171
Showing 1 changed file with 23 additions and 30 deletions.
53 changes: 23 additions & 30 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,17 @@
# Contributing

Contributions are always welcome, no matter how large or small!
We value code contributions, but non-code contributions too, from writers, editors, testers, etc. are always welcomed. Join us to contribute
* To contribute to code, [repository](https://github.com/mosip/tuvali)
* To contribute to documentation, [repository](https://github.com/mosip/documentation/blob/inji/docs/integration-guide/tuvali-inji.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.

## Code of Conduct
This project and everyone participating in it is governed by the [code of conduct](./CODE_OF_CONDUCT.md).
This project and everyone participating in it is governed by the [code of conduct](https://docs.mosip.io/1.2.0/community/code-of-conduct).

## Before Submitting a Pull Request
This guide will help you to contribute in various aspects like raising issues, feature request, etc.

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

- 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.

### Development workflow
## Project Initial Setup

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

Expand Down Expand Up @@ -55,7 +44,7 @@ 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
## Commit message convention

We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:

Expand All @@ -68,25 +57,15 @@ We follow the [conventional commits specification](https://www.conventionalcommi

Our pre-commit hooks verify that your commit message matches this format when committing.

### Linting and tests
## Linting and tests

[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)

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.

Our pre-commit hooks verify that the linter and tests pass when committing.

### Publishing to npm

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.

To publish new versions, run the following:

```sh
yarn release
```

### Scripts
## Scripts

The `package.json` file contains various scripts for common tasks:

Expand All @@ -95,6 +74,20 @@ The `package.json` file contains various scripts for common tasks:
- `yarn lint`: lint files with ESLint.
- `yarn test`: run unit tests with Jest.

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

- 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.


## Reporting an issue

Expand Down

0 comments on commit e85b171

Please sign in to comment.