Skip to content

Latest commit

 

History

History
126 lines (76 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

126 lines (76 loc) · 2.94 KB
Raw

Contributing Guide

Thank you for your interest in contributing to the React Nepali Datetime Picker project! Your contributions will help improve and enhance this library. Please take a moment to review the guidelines before getting started.

Before Getting Started

Before you start contributing, please ensure that you have the following prerequisites:

  • Node.js 16.8 or higher installed on your machine. You can download it from the official Node.js website. Alternatively, you can use nvm to manage multiple Node.js versions.

Getting Started

To set up the project on your local machine, follow these steps:

  1. Clone the repository:
   git clone https://github.com/binodnepali/react-nepali-datetime-picker.git
   # or
   git clone git@github.com:binodnepali/react-nepali-datetime-picker.git
  1. Navigate to the cloned repository:
   cd react-nepali-datetime-picker
  1. Install project dependencies:
   npm install
   # or
   yarn install
   # or
   pnpm install
  1. Start the development server:
   npm run dev
   # or
   yarn dev
   # or
   pnpm dev
  1. Build the project for production:
   npm run build
   # or
   yarn build
   # or
   pnpm build
  1. Run lint checks:
   npm run lint
   # or
   yarn lint
   # or
   pnpm lint
  1. Start the preview server after building:
   npm run preview
   # or
   yarn preview
   # or
   pnpm preview

Pull Requests

We welcome and appreciate pull requests from the community. If you have any improvements, bug fixes, or new features to contribute, please follow these steps:

  1. Fork the repository and create a new branch based on the main branch.

  2. Make your changes and ensure that the codebase adheres to the project's linting rules.

  3. Write tests for your changes if applicable.

  4. Commit your changes with descriptive commit messages.

  5. Push your branch to your forked repository.

  6. Create a pull request from your branch to the main branch of the original repository.

  7. Provide a clear and concise description of your changes in the pull request, along with any additional context or information that may be useful.

  8. Participate in the code review process and address any feedback or suggestions.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License. For more details, please see the LICENSE file.

Author

If you have any questions, feedback, or need further assistance, feel free to reach out to the author.

Thank you for your valuable contributions to the React Nepali Datetime Picker project! We appreciate your efforts in making this library even better.