This is a project to create a Rogue like using Rust and Bevy.
In this project the versioning number is managed using Semver specification. The version number should be updated in the Cargo.toml of the project.
PRs to our project are always welcome and can be a quick way to get your fix or improvement slated for the next version. In general, PRs should:
- Only fix/add the functionality in question OR address style problems of the code.
- Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
- Address a single concern in the least number of changed lines as possible.
- Include documentation in the repo.
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
In general, we follow the "fork-and-pull" Git workflow
- Fork the repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Update version in the Cargo.toml .
- Commit changes to the branch
- Following any formatting and testing guidelines specific to this repo
- Push changes to your fork
- Open a PR in the repository.
- After the contribution is merged you will be added to the contributors list!
The list or contributors by chronological order is: