diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..75ed3ab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing to siz + +We welcome contributions to the `siz` project under the Apache License v2.0. Whether you're looking to fix bugs, add new features, or improve documentation, your help is greatly appreciated. + +Here's how you can contribute: + +1. **Fork the Repository**: Fork the `siz` repository to your GitHub account. + +2. **Clone the Repository**: Clone the forked repository to your local machine. + + ```text + git clone https://github.com//siz.git + ``` + +3. **Create a New Branch**: Create a new branch for your changes. + + ```text + git checkout -b add-new-feature + ``` + +4. **Make Your Changes**: Make changes to the code or documentation. + +5. **Commit Your Changes**: Commit your changes to your branch. Include a commit message that briefly describes your changes. + + ```text + git commit -m "Add new feature" + ``` + +6. **Push Your Changes**: Push your changes to your forked repository on GitHub. + + ```text + git push origin add-new-feature + ``` + +7. **Submit a Pull Request**: Follow the [GitHub Pull Request instructions](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to create a new pull request with your proposed changes. + +**Before submitting a pull request**, please ensure your code compiles and all tests, including the clippy lints, pass. If you're adding a new feature, please add tests that cover the new feature. + +You can run the following commands in the root of your downstream source repository to execute these tests before you submit your pull request: + +```text +cargo test +cargo clippy +``` + +Please feel free to reach out if you have any questions or need help contributing. diff --git a/README.md b/README.md index 694f8ba..adf12e7 100644 --- a/README.md +++ b/README.md @@ -118,50 +118,7 @@ Please use the GitHub issue tracker to report bugs or other issues. Thanks! ## Contributing -We welcome contributions to the `siz` project under the Apache License v2.0. Whether you're looking to fix bugs, add new features, or improve documentation, your help is greatly appreciated. - -Here's how you can contribute: - -1. **Fork the Repository**: Fork the `siz` repository to your GitHub account. - -2. **Clone the Repository**: Clone the forked repository to your local machine. - - ```text - git clone https://github.com//siz.git - ``` - -3. **Create a New Branch**: Create a new branch for your changes. - - ```text - git checkout -b add-new-feature - ``` - -4. **Make Your Changes**: Make changes to the code or documentation. - -5. **Commit Your Changes**: Commit your changes to your branch. Include a commit message that briefly describes your changes. - - ```text - git commit -m "Add new feature" - ``` - -6. **Push Your Changes**: Push your changes to your forked repository on GitHub. - - ```text - git push origin add-new-feature - ``` - -7. **Submit a Pull Request**: Follow the [GitHub Pull Request instructions](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to create a new pull request with your proposed changes. - -**Before submitting a pull request**, please ensure your code compiles and all tests, including the clippy lints, pass. If you're adding a new feature, please add tests that cover the new feature. - -You can run the following commands in the root of your downstream source repository to execute these tests before you submit your pull request: - -```text -cargo test -cargo clippy -``` - -Please feel free to reach out if you have any questions or need help contributing. +Please see [CONTRIBUTING.md](CONTRIBUTING.md). ## License