Skip to content

Latest commit

 

History

History
94 lines (57 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

94 lines (57 loc) · 2.16 KB
Raw

Contributing Guidelines

Thank you for considering contributing to ts-gen-typeguards! We welcome contributions from the community to help improve the project.

Getting Started

  • Make sure you have Node.js and npm installed on your system.

Fork the Repository

  1. Fork the ts-gen-typeguards repository to your own GitHub account.
  2. Clone your forked repository to your local machine.
git clone https://github.com/rohit1901/ts-gen-typeguards.git
  1. Navigate to the project directory.
cd ts-gen-typeguards

Installation

  1. Install project dependencies.
npm install

Making Changes

  1. Create a new branch for your changes.
git checkout -b your-branch-name
  1. Make your desired changes to the codebase.

Running Tests & Linting

Before submitting your changes, make sure all tests pass successfully and are properly linted.

npm test
npm run lint

Code Formatting

Please format your code using Prettier for consistent code style.

npm run prettify

Commit and Push

  1. Commit your changes.
git commit -m "Your descriptive commit message"
  1. Push your changes to your forked repository.
git push origin your-branch-name

Submitting a Pull Request

  1. Go to your forked repository on GitHub and open a pull request preferble to feature/patch (feature/minor, feature/major) DO NOT create PR into main.
  2. Provide a clear title and description for your pull request.
  3. Mention any related issues if applicable.

Code Review

Your pull request will be reviewed by project maintainers. Feedback and suggestions may be provided to improve the contribution.

Licensing

By contributing to this repository, you agree that your contributions will be licensed under the MIT License.

Reporting Issues

If you encounter any issues or have suggestions, please open an issue in the repository.

I appreciate your time and effort in contributing to ts-gen-typeguards. Your contributions are valuable and help make the project better!

Happy coding!