https://github.com/vinatorul/tileengine-rs

Tile engine in Rust
https://github.com/vinatorul/tileengine-rs

Last synced: 11 months ago
JSON representation

Tile engine in Rust

• Host: GitHub
• URL: https://github.com/vinatorul/tileengine-rs
• Owner: Vinatorul
• License: mit
• Created: 2015-08-31T18:11:08.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2016-03-08T21:18:33.000Z (over 10 years ago)
• Last Synced: 2025-05-16T21:37:40.996Z (about 1 year ago)
• Language: Rust
• Size: 539 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# tileengine-rs [![Build Status](https://travis-ci.org/Vinatorul/tileengine-rs.svg?branch=master)](https://travis-ci.org/Vinatorul/tileengine-rs) [![Coverage Status](https://coveralls.io/repos/Vinatorul/tileengine-rs/badge.svg?branch=master&service=github)](https://coveralls.io/github/Vinatorul/tileengine-rs?branch=master) [![](http://meritbadge.herokuapp.com/tile_engine)](https://crates.io/crates/tile_engine) [![license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Vinatorul/tileengine-rs/blob/master/LICENSE)

Tile engine in Rust

[Documentation](https://vinatorul.github.io/tileengine-rs/tile_engine)

## License

`tile_engine` is licensed under the MIT license. Please read the LICENSE file in this repository for more information.

# [How to Contribute](https://github.com/Vinatorul/tileengine-rs/blob/master/CONTIBUTING.md)

Contributions are always welcome! Please use the following guidelines when contributing to `tile_engine`

1. Fork `tile_engine`

2. Clone your fork (`git clone https://github.com/$YOUR_USERNAME/tileengine-rs && cd tileengine-rs`)

3. Create new branch (`git checkout -b new-branch`)

4. Make your changes, and commit (`git commit -am "your message"`)

 * I use a [conventional](https://github.com/ajoslin/conventional-changelog/blob/a5505865ff3dd710cf757f50530e73ef0ca641da/conventions/angular.md) changelog format so I can update my changelog using [clog](https://github.com/thoughtram/clog)

 * In addition to the conventions defined above, I also use `imp`, `wip`, `gr`.

 * Format your commit subject line using the following format: `TYPE(COMPONENT): MESSAGE` where `TYPE` is one of the following:

    - `feat` - A new feature

    - `imp` - An improvement to an existing feature

    - `perf` - A performance improvement

    - `tests` - Changes to the testing framework or tests only

    - `fix` - A bug fix

    - `refactor` - Code functionality doesn't change, but underlying structure may

    - `style` - Stylistic changes only, no functionality changes

    - `wip` - A work in progress commit (Should typically be `git rebase`'ed away)

    - `chore` - Catch all or things that have to do with the build system, etc

    - `gr` - Graphics changes

 * The `COMPONENT` is optional, and may be a single file, directory, or logical component. Can be omitted if commit applies globally

5. Run the tests (`cargo test`)

6. `git rebase` into concise commits and remove `--fixup`s (`git rebase -i HEAD~NUM` where `NUM` is number of commits back)

7. Push your changes back to your fork (`git push origin $your-branch`)

8. Create a pull request! (You can also create the pull request first, and we'll merge when ready. This a good way to discuss proposed changes.)