Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.8 KB
Raw

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/brook-code-theme/official-website.git
  2. Install the dependencies by run 
      npm install --legacy-peer-deps --silent
  3. Start the development server 
      npm run dev
  4. Open the application in your browser http://localhost:3000

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 [email protected] 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.