diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 32 | ||||
| -rw-r--r-- | .github/workflows/main.yml | 2 |
2 files changed, 33 insertions, 1 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. + diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0e291ae..2e72a89 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -14,7 +14,7 @@ jobs: container: image: debian:testing steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - run: apt -y update - run: apt -y install g++-multilib libboost-dev make nasm yasm - run: make test |