🧑‍💻

Contributing to Graphweaver

Thank you for your interest in contributing to Graphweaver! Here's a short guide to get you started:

  1. Getting Started: Ensure you have Node.js installed, clone the GitHub repo and open the ./graphweaver.code-workspacein VSCode.
  2. Setting up the Development Environment: Move to the ./srcdirectory and install dependencies with pnpm install. Then run the build pnpm build.
  3. Making Contributions:
    • Find an open issue or create a new one.
    • Create a descriptive branch for your changes.
    • Write clear, well-documented, and tested code.
    • Submit a pull request with a detailed description of your changes.
  4. Code Guidelines:
    • Follow the existing coding style and conventions.
    • Write comprehensive tests for your changes.
    • Keep the code modular and reusable.
  5. Documentation: Document new features and update existing documentation as needed. (we will need to manage this for you)
  6. Community and Communication: Join the Graphweaver Discord server for discussions and support.

Remember, your contributions are valuable and help improve Graphweaver for everyone.

Start small, ask for help when needed, and enjoy the collaborative experience!

Happy coding!

Exogee