1. Journal Stack Home

Contributing

Contributions to Remix Development Tools are welcome! To contribute, please follow these guidelines:

  1. Fork the repository and clone it locally.
  2. Create a new branch for your feature or bug fix.
  3. Run npm run dev to start the development server with a vanilla Remix app setup.
  4. Implement your changes, adhering to the existing code style and best practices.
  5. Please add tests for any new features or bug fixes.
  6. Commit and push your changes to your forked repository.
  7. Open a pull request, providing a clear description of your changes and their purpose.

Contributing on Remix Forge integrations

If you want to contribute to the VS Code extension integration follow the steps above and then:

  1. Clone the repo for Remix Forge locally.
  2. Open it in VS Code.
  3. Run npm install
  4. Run npm run dev
  5. Click F5 which will launch a debugger instance of VS Code.
  6. In the debugger instance of VS Code, start the remix dev tools
  7. Click Connect to Remix Forge in the Remix Dev Tools
  8. Code on!