diff options
author | MITSUNARI Shigeo <[email protected]> | 2024-05-09 13:37:02 +0900 |
---|---|---|
committer | MITSUNARI Shigeo <[email protected]> | 2024-05-09 13:37:02 +0900 |
commit | f38885229ada3cab8aaa9550838214953a8b62e8 (patch) | |
tree | 5c53d141b46b9d2b320e59d8dccf314e4d77e193 /.github | |
parent | 05bdd062f0678359981431360ad8a53c0192f0fd (diff) | |
download | xbyak-f38885229ada3cab8aaa9550838214953a8b62e8.tar.gz xbyak-f38885229ada3cab8aaa9550838214953a8b62e8.zip |
[doc] add CONTRIBUTING.md
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..5f91cab --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing to Xbyak + +Thank you for considering contributing to the Xbyak project. This document provides guidelines on how to contribute. + +## Bug Reports and Feedback + +If you find a bug, have a feature request, or have questions, please open an issue. Include the following information: + +- Detailed description of the problem +- Steps to reproduce +- Expected behavior +- Actual behavior +- Environment details (OS, compiler version, etc.) + +## Creating Pull Requests + +If you want to add features or make fixes, follow these steps to create a pull request: + +1. Fork the repository +2. Create a new branch: `git checkout -b my-feature-branch` +3. Make your changes +4. Run tests and ensure all tests pass +5. Commit your changes: `git commit -am 'Add new feature'` +6. Push the branch: `git push origin my-feature-branch` +7. Create a pull request + +When creating a pull request, clearly describe the changes and include any related issue numbers. + +## License + +Xbyak is released under the BSD-3-Clause License. Any code contributions will be licensed under the same license. + |