Skip to content

Latest commit

 

History

History
40 lines (36 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

40 lines (36 loc) · 1.66 KB

👽 As an user

If you would like to have a feature implemented or you noticed a bug, do not hesitate to write an issue in the repository.

💻 As a developer

Please take into account that this is just a showcase of a Rust webapp with image manipulation. Thus, complexity is usually avoided in favor of clarity.

🎨 Style

  • Use semantic commits.
  • 23 incremental Pull Requests are better than 1 commit of 27,000 lines.
  • Before committing, format the code and search for lint warnings (both must be checked to pass CI): 
    cargo fmt
cargo clippy
  • Tests, benchmarks and documentation are always welcome!

🚀 Enhancements, bugfixes or feature

Changes and propositions are considered and welcomed.

  1. Look up similar issues.
  2. Write an issue.
  3. Fork the repository.
# https
git clone https://github.com/carrascomj/dalted.git
# or ssh
git clone git@github.com:carrascomj/dalted.git
  1. Branch from trunk.
git checkout -b 'feat-incrediblefeature'
  1. Commit a whole bunch of stuff (this video might be helpful to understand Git).
  2. Submit a Pull Request with your feature/bug fix.
  3. Get the Pull Request approved (CI must pass).