Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.26 KB
Raw

Contributing to GhostChat

Feel free to submit issues and enhancement requests.

Please use issues or Discord to report bugs and errors.

Contributing

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Setup

Prerequisites:

  • Ensure that pnpm is installed

Install dependencies with pnpm install

GitHooks are executed on commit. This means linting the project before a commit can be created. This process also runs on Git Hub to ensure that the styling guidelines are met and no build errors are produced. Once the pull request is created, all the pipelines need to succeed to be able to be merged into the main branch. If any of them fail you'll need to fix the issues before.