@@ -157,7 +160,7 @@ Please install `pre-commit` before `git commit` to run all pre-checks.
pre-commit install
```
Pull requests should be submitted to [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev).
Open a pull request to main branch on GitHub.
## Contributing
...
...
@@ -185,16 +188,16 @@ SuperBenchmark is an open-source project. Your participation and contribution ar
1. Bug fixes for existing features.
2. New features for benchmark module (micro-benchmark, model-benchmark, etc.)
If you would like to contribute a new feature on SuperBenchmark, please submit your proposal first. In [GitHub Issues](https://github.com/microsoft/superbenchmark/issues) module, choose `Enhancement Request` to finish the submission. If the proposal is accepted, you can submit pull request to origin [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev).
If you would like to contribute a new feature on SuperBenchmark, please submit your proposal first. In [GitHub Issues](https://github.com/microsoft/superbenchmark/issues) module, choose `Enhancement Request` to finish the submission. If the proposal is accepted, you can submit pull requests to origin main branch.
#### Contribution steps
If you would like to contribute to the project, please follow below steps of joint development on GitHub.
1.`Fork` the repo first to your personal GitHub account.
2. Checkout from [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev) for feature development.
2. Checkout from main branch for feature development.
3. When you finish the feature, please fetch the latest code from origin repo, merge to your branch and resolve conflict.
4. Submit pull request to origin [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev).
4. Submit pull requests to origin main branch.
5. Please note that there might be comments or questions from reviewers. It will need your help to update the pull request.