Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.95 KB

Contributing

Hall of Contributors

  • Muhtasim Rasheed - Creator and maintainer of Crust
  • P4ncake! - Co-creator of Crust; implemented effects and designed the logo
  • Possibly you?

Dear potential contributor,

Thank you for your interest in contributing to Crust! We appreciate your time and effort. To ensure a smooth contribution process, please follow these guidelines:

  1. Fork the Repository: Start by forking the repository to your own GitHub account. This allows you to make changes without affecting the original project.
  2. Clone Your Fork: Clone your forked repository to your local machine using the command: 
    git clone https://github.com/your-username/crust-engine.git
  3. Build the project: Before making any changes, ensure that you can build the project successfully and also install all dependencies. Navigate to the project directory and run: 
    cargo build
  4. You're ready to hack!

Things you can do

  • Improve features
  • Fix bugs
  • Tweak/Improve the documentation
  • Help split the still big monolithic file crust-engine/src/utils/sprite/sprite.rs into smaller files
  • Pick a good first issue or any other issue that interests you

Even tiny changes are welcome (Seriously)!

Code style

Before commiting, run:

cargo fmt

This will format the codebase with rustfmt. Keeping things neat helps everyone.

Commit messages

When committing changes, please use clear and descriptive commit messages. But silly commit messages are also welcome, as long as they are not too silly. For example:

  • "Fix typo in README"
  • "Add new feature to improve user experience"
  • "Refactor code for better readability"
  • "horror", "horror 2", "less horror", "no more horror"
  • "sorry i added my test directory"