Skip to main content

Contributing

If you're interested in contributing to the Argon project, you're very welcome to do so! We're always looking for new contributors to help us improve and maintain this awesome project!

Main Repositories​

Argon is a big project that consists of multiple parts. Here are the main repositories you can contribute to.

Argon CLI​

This is the main part of the Argon project. It's written in Rust and is responsible for managing, building and live syncing your projects. If you're interested in contributing, visit the GitHub repository.

Argon Roblox​

This is the Roblox Studio plugin that connects to the Argon CLI. It's written in Luau and is responsible for syncing your place with the file system. If you're interested in contributing, visit the GitHub repository.

Argon VS Code​

This is the Visual Studio Code extension that wraps Argon CLI. It's written in TypeScript and is responsible for providing you with a nice interface to interact with the Argon core. If you're interested in contributing, visit the GitHub repository.

Argon Wiki​

This is the website you're currently reading. It's written in MDX and is responsible for providing you with all the information you need to get started with Argon. If you're interested in contributing, visit the GitHub repository.

Argon Legacy​

This is the old and completely different version of Argon. It was was written in JavaScript and is longer maintained but any bug fixes are still welcome. If you're interested in contributing, visit the GitHub repository.

How to Contribute​

If you're interested in contributing to any of the repositories, you can do so in multiple ways.

Making Changes​

If you want to add a new feature, fix a bug or improve something, you can do so by following these steps:

  1. Fork the Repository you want to contribute to.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes (optional).
  4. Make your changes.
  5. Commit your changes.
  6. Push your changes to your forked repository.
  7. Create a Pull Request.

Reporting Issues​

If you find a bug or have a feature request, you can report it by following these steps:

  1. Go to the Repository you want to report to.
  2. Click on the Issues tab.
  3. Click on the New Issue button.
  4. Fill in the issue template.
  5. Click on the Submit new issue button.