# Contributing to Community Standards Thank you for your interest in contributing to Community Standards! We welcome any contributions, including bug fixes, feature enhancements, documentation improvements, and other general improvements. ## Getting Started 1. Fork this repository to your GitHub account. This will create a copy of this repository in your account. You can make changes to this copy without affecting the original repository. - For fork this repository, click the **Fork** button in the top right corner of this page or click [here](https://github.com/prasanthrangan/hyprdots/fork). 2. Clone your forked repository to your local machine. - Use the following command to clone your forked repository to your local machine. ```bash git clone https://github.com/Matt-FTW/dotfiles.git ``` 3. Create a new branch for your changes. - For example, to create a new branch named `your-branch-name`, use the following command. ```bash git checkout -b your-branch-name ``` 4. Make your changes and commit them with a descriptive commit message. - For example, to commit your changes, use the following command and make sure to follow the [commit message guidelines](./COMMIT_MESSAGE_GUIDELINES.md). ```bash git commit -m "feat: add a new feature" ``` 5. Push your changes to your forked repository. - For example, to push your changes to your forked repository, use the following command. ```bash git push origin your-branch-name ``` 6. Submit a **pull request** to the upstream repository. - For example, to create a pull request, use the following steps. 1. Go to your forked repository. 2. Click the **Compare & pull request** button next to your `your-branch-name` branch. 3. Add a title and description for your pull request. 4. Click **Create pull request** and remember to add the relevant labels with using the [pull request template](./PULL_REQUEST_TEMPLATE.md). ## Guidelines - Follow the code style of the project. - Update the **documentation** if necessary. - Add tests if applicable. - Make sure all tests pass before submitting your changes. - Keep your pull request focused and avoid including unrelated changes. - Remember to follow the given files before submitting your changes. - [bug_report.yml](./ISSUE_TEMPLATE/bug_report.yml) - Use this template to create a report to help us improve. - [feature_request.yml](./ISSUE_TEMPLATE/feature_request.yml) - Use this template to suggest a feature for this project. - [documentation_update.yml](./ISSUE_TEMPLATE/documentation_update.yml) - Use this template to propose a change to the documentation. - [custom.md](./ISSUE_TEMPLATE/custom.md) - Use this template to submit a custom issue. - [PULL_REQUEST_TEMPLATE.md](./PULL_REQUEST_TEMPLATE.md) - Use this template to submit a pull request. - [COMMIT_MESSAGE_GUIDELINES.md](./COMMIT_MESSAGE_GUIDELINES.md) - Read this file to learn about the commit message guidelines. - [CONTRIBUTING.md](./CONTRIBUTING.md) - Read this file to learn about the contributing guidelines. - [LICENSE](../LICENSE) - Read this file to learn about the license. - [README.md](./README.md) - Read this file to learn about the project. ## Contact If you have any questions, feel free to contact via [GitHub Discussions](https://github.com/Matt-FTW/dotfiles/discussions) or via email at sergiolain11@gmail.com