Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (40 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 2.57 KB

Contributing

Thank you for your interest in contributing to this project. Your help in making this project better is much appreciated.

Getting Started

Before you begin contributing, please read the README file to understand the project and its goals. If you have any questions, feel free to ask in the Issues section.

To set up the project locally, follow these steps:

  1. Clone the repository

      git clone https://github.com/moonospace/okay.git

  2. Install the dependencies by running the following command.

      npm i

  3. After everything ready, now start the development server by running the following command.

      npm run dev

  4. Open the application in your browser http://localhost:3000, enjoy the development time.

  5. For more detail, you can see the detail command bellow.

Command Description
npm i Install project dependencies.
npm run dev Start the development server in development mode.
npm run build Build the project for production deployment.
npm run preview Serve the production build locally for preview.
npm run test Run all tests associated with the project.
npm run check Lint the project files to ensure code quality and style.

Issues and Pull Requests

If you find a bug or have a feature request, please create an issue in the issue tracker before starting work on it. This will ensure that the issue is not already being worked on by someone else, and will allow other contributors to provide feedback and suggestions.

If you want to contribute code, please fork the repository and submit a pull request. Make sure your pull request:

  • Addresses an open issue.
  • Follows the Code of Conduct of the project.
  • Adheres to the project's Code Style.
  • Includes a description of the changes made in the pull request.

Testing

Please make sure your code passes all tests before submitting a pull request.To run tests, use the command npm run test.

Security

If you find a security vulnerability in the project, please do not create an issue. Instead, contact the maintainers directly at nyomansunima@gmail.com to report the issue.

Code of Conduct

Please note that we have a Code of Conduct in place. We expect all contributors to follow it in all interactions with the project.