# Contribution Guidelines Thank you for considering contributing to our project! Contributions are very welcome 🙏 We appreciate your time and effort in helping us improve the project. To ensure a smooth collaboration, please follow these guidelines: ## Getting Started 1. **Fork the Repository**: Start by forking the repository to your GitHub account. 2. **Clone the Repository**: Clone the forked repository to your local machine using: ```bash git clone https://github.com/zetxek/adritian-free-hugo-theme.git ``` 3. **Create a Branch**: Create a new branch for your feature or bug fix: ```bash git checkout -b feature/your-feature-name ``` ## Making Changes 1. **Code Style**: Follow the project's coding style and conventions. Ensure your code is clean and well-documented. 2. **Commit Messages**: Write clear and concise commit messages. Use the present tense and include a brief description of the changes. 3. **Testing**: Ensure your changes work well with the test site (and others, maybe with yours), in mobile and desktop browsers. ## Submitting Changes 1. **Push Changes**: Push your changes to your forked repository: ```bash git push origin feature/your-feature-name ``` 2. **Create a Pull Request**: Open a pull request (PR) from your branch to this repository's `main` branch. Provide a detailed description of your changes and link any relevant issues. ## Code Review 1. **Review Process**: Your PR will be reviewed by project maintainers (mainly @zetxek). Be responsive to feedback and make necessary changes. 2. **Approval**: Once your PR is approved, it will be merged into the main branch. 🎗️ Remember that the maintainers are working in a voluntary basis - do not expect a quick turnaround, as they will get to the issue when life allows. ## Community Guidelines You can read about our guidelines in our [code of conduct](https://github.com/zetxek/adritian-free-hugo-theme/blob/main/CODE_OF_CONDUCT.md). ## Reporting Issues 1. **Bug Reports**: If you find a bug, please open an [issue](https://github.com/zetxek/adritian-free-hugo-theme/issues) with a clear description and steps to reproduce the problem. 2. **Feature Requests**: If you have an idea for a new feature, open an [issue](https://github.com/zetxek/adritian-free-hugo-theme/issues) to discuss it with the community. Support is not offered in private, direct mails - as they won't directly benefit the community. ## License By contributing to this project, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE) file.