Thank you for considering contributing to CarbonLauncher, a mod loader for Scrap Mechanic! Your help is greatly appreciated. Below are some guidelines to help you get started.
- Code of Conduct
- How to Contribute
- Reporting Bugs
- Suggesting Features
- Pull Requests
- Development Setup
Please read and follow our Code of Conduct to ensure a welcoming environment for all contributors.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature-branch). - Open a pull request.
If you find a bug, please report it by opening an issue. Include as much detail as possible:
- Steps to reproduce the bug.
- Scrap Mechanic version.
- CarbonLauncher version.
- Any relevant logs or screenshots.
We welcome feature suggestions! To suggest a new feature:
- Check if the feature is already requested in the issues.
- If not, open a new issue with a detailed description of the feature and why it would be useful.
When submitting a pull request:
- Ensure your code follows the project's coding style.
- Write clear, concise commit messages.
- Include tests for new features or bug fixes.
- Ensure all tests pass before submitting.
To set up the development environment:
- Clone the repository:
git clone https://github.com/yourusername/CarbonLauncher.git - Navigate to the project directory:
cd CarbonLauncher - Install dependencies:
npm install(or the appropriate command for your package manager) - Run the project:
npm start(or the appropriate command for your project)
Thank you for contributing to CarbonLauncher!