|
| 1 | +# Contributing to update-custom-properties |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the `update-custom-properties` project! Whether you're submitting a bug report, fixing a bug, or adding a feature, we appreciate your help in making this action better. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +### Reporting Issues |
| 8 | + |
| 9 | +If you've encountered a bug or have a suggestion for improvement, please check the [Issues](https://github.com/PandasWhoCode/update-custom-properties/issues) tab to see if it's already been reported. If not, feel free to open a new issue with as much detail as possible, including: |
| 10 | + |
| 11 | +- A clear description of the problem or feature request. |
| 12 | +- Steps to reproduce the issue (if applicable). |
| 13 | +- The expected behavior and any error messages. |
| 14 | +- Your environment details (e.g., operating system, GitHub Actions version). |
| 15 | + |
| 16 | +### Submitting a Pull Request |
| 17 | + |
| 18 | +We welcome contributions through pull requests! To submit a pull request: |
| 19 | + |
| 20 | +1. **Fork the repository**: |
| 21 | + Click the "Fork" button at the top of the repository page to create a copy of the project under your GitHub account. |
| 22 | + |
| 23 | +2. **Clone your fork**: |
| 24 | + Clone your forked repository to your local machine: |
| 25 | + ```bash |
| 26 | + git clone https://github.com/YOUR_USERNAME/update-custom-properties.git |
| 27 | + ``` |
| 28 | + |
| 29 | +3. **Create a branch**: |
| 30 | + Create a new branch for your changes: |
| 31 | + ```bash |
| 32 | + git checkout -b feature-branch |
| 33 | + ``` |
| 34 | + |
| 35 | +4. **Make your changes**: |
| 36 | + Make your changes to the codebase. Ensure that you test your changes thoroughly and maintain existing functionality. |
| 37 | + |
| 38 | +5. **Commit your changes**: |
| 39 | + Commit your changes with a clear and concise commit message. Follow the [Conventional Commit](https://www.conventionalcommits.org/) guidelines if possible. |
| 40 | + ```bash |
| 41 | + git commit -m "feat: added new feature to install specific version" |
| 42 | + ``` |
| 43 | + |
| 44 | +6. **Push your changes**: |
| 45 | + Push your changes to your forked repository: |
| 46 | + ```bash |
| 47 | + git push origin feature-branch |
| 48 | + ``` |
| 49 | + |
| 50 | +7. **Create a Pull Request**: |
| 51 | + Open a pull request (PR) from your feature branch to the `main` branch of the original repository. |
| 52 | + |
| 53 | +8. **Describe your changes**: |
| 54 | + Provide a detailed description of the changes you made in the PR and link any relevant issues. |
| 55 | + |
| 56 | +### Code Style |
| 57 | + |
| 58 | +- Use [Prettier](https://prettier.io/) to format your code. |
| 59 | +- Ensure that your code follows the conventions and structure of the existing codebase. |
| 60 | + |
| 61 | +### Testing |
| 62 | + |
| 63 | +Ensure that your changes do not break existing functionality. If possible, include tests for any new features or bug fixes. |
| 64 | + |
| 65 | +### Documentation |
| 66 | + |
| 67 | +If you make changes that affect how the action works or how it is used, please update the documentation (including the `README.md` and this `CONTRIBUTING.md`) to reflect the changes. |
| 68 | + |
| 69 | +## License |
| 70 | + |
| 71 | +By contributing to this project, you agree that your contributions will be licensed under the [Apache License 2.0](https://github.com/PandasWhoCode/update-custom-properties?tab=Apache-2.0-1-ov-file#readme). |
| 72 | + |
| 73 | +## Code of Conduct |
| 74 | + |
| 75 | +By participating in this project, you agree to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md). We strive to maintain a welcoming and respectful community for everyone. |
| 76 | + |
| 77 | +## Thank You! |
| 78 | + |
| 79 | +Your contributions are what make this project great. Thank you for helping improve `update-custom-properties`! |
| 80 | + |
| 81 | +--- |
| 82 | + |
| 83 | +**Author**: [Roger Barker](https://github.com/DJ-BBot) |
| 84 | + |
0 commit comments