Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

86 lines (54 loc) · 2.29 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our React Library project! We welcome contributions from the community. To ensure a smooth and collaborative process, please follow the guidelines below.

Prerequisites

  • Node.js version 18.16.0 is required to work on this project.

Getting Started

To contribute to the project, follow these steps:

  1. Fork the repository by clicking on the "Fork" button at the top right corner of the repository page. This creates a copy of the repository in your GitHub account.

  2. Clone the repository to your local machine using Git. Replace <your-username> with your GitHub username:

$ git clone https://github.com/<your-username>/sagu-ui.git
  1. Change to the project's directory:
$ cd sagu-ui
  1. Install the project dependencies:
$ yarn install
  1. Create a new branch for your changes:
$ git checkout -b my-feature
  1. Run the project locally to test your changes:
$ yarn sb

  1. Make your desired changes to the codebase using your favorite code editor.

  2. Test your changes.

$ yarn test
$ yarn typecheck
$ yarn prettier:check
  1. Commit your changes with a descriptive commit message:
$ git commit -m "Add new feature: XYZ"
  1. Push your changes to your forked repository:
$ git push origin my-feature

  1. Open a pull request from your forked repository to the original repository. Provide a clear title and description for your pull request, explaining the changes you've made.

  2. Engage in the review process, addressing any feedback or requested changes.

  3. Once your pull request is approved and passes all necessary checks, it will be merged into the main branch.

Code Style and Guidelines

  • Follow the established code style and guidelines of the project.
  • Write clear, concise, and well-documented code.
  • Ensure your code adheres to the project's linting rules.
  • Avoid more them 1 commit per PR

Thank You

We appreciate your contribution to our React Library project! Your effort helps improve the library for everyone in the community. Thank you for your support!

Please note that by contributing to this project, you agree to abide by the Code of Conduct.

Happy coding!