# Contributing to AppCUI-rs Thank you for considering contributing to AppCUI-rs! Here are some guidelines to help you get started: ## ๐Ÿ› ๏ธ How to Contribute 1. **Fork the Repository** Create a fork of the repository by clicking the "Fork" button at the top of the GitHub page. 2. **Clone Your Fork** Clone your forked repository to your local machine: ```bash git clone https://github.com/gdt050579/AppCUI-rs.git ``` 3. **Create a Branch** Create a new branch for your feature or bug fix: ```bash git checkout -b feature-or-bugfix-name ``` 4. **Make Changes** Make your changes to the codebase. Ensure your code follows the project's coding standards. 5. **Test Your Changes** Run the tests to ensure your changes do not break existing functionality: ```bash cargo test -- --test-threads=1 ``` 6. **Commit Your Changes** Commit your changes with a clear and descriptive commit message: ```bash git commit -m "Add feature or fix bug description" ``` 7. **Push Your Changes** Push your changes to your forked repository: ```bash git push origin feature-or-bugfix-name ``` 8. **Create a Pull Request** Open a pull request from your branch to the `main` branch of the original repository. Provide a detailed description of your changes. ## ๐Ÿ“œ Code of Conduct Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming environment for all contributors. ## ๐Ÿงช Testing - Ensure all tests pass before submitting your pull request. - Add tests for any new features or bug fixes. ## ๐Ÿ’ก Suggestions and Issues If you have ideas for new features or find a bug, feel free to open an issue on GitHub. Be as detailed as possible. ## ๐Ÿ“ Documentation If your contribution affects the documentation, please update the relevant sections in the `README.md` or other documentation files. Thank you for contributing to AppCUI-rs! ๐ŸŽ‰