# Contributing to xCrash

Welcome to the xCrash project. Read on to learn more about our development process and how to propose bug fixes and improvements.

## Issues

We use GitHub issues to track public bugs and feature requests. Before creating an issue, please note the following:

1. Please search existing issues before creating a new one.
2. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. The more information the better.


## Branch Management

There are 2 main branches:

1. `master` branch

    * It's the latest (pre-)release branch. We use `master` for tags.
    * **Please do NOT submit any PR on `master` branch.**

2. `dev` branch

    * It's our stable developing branch.
    * Once `dev` has passed our internal tests, it will be merged to `master` branch for the next release.
    * **Please always submit PR on `dev` branch.**


## Pull Requests

Please make sure the following is done when submitting a pull request:

1. Fork the repo and create your branch from `master`.
2. Add the copyright notice to the top of any new files you've added.
3. Check your Java code lints and checkstyles.
4. Try your best to test your code.
5. Squash all of your commits into one meaningful commit.


## Code Style Guide

1. 4 spaces for indentation rather than tabs.
2. Follow this [checkstyle configuration](src/java/xcrash/checkstyle.xml) for Java code.
3. Follow the C code style already in place.


## License

By contributing to xCrash, you agree that your contributions will be licensed under its [MIT LICENSE](LICENSE).