aottr.dev
Free and open source ticket system written in python
1# Contributing to paw
2
3Welcome to paw! We appreciate your interest in contributing to my project.
4
5How to Contribute
6To contribute to paw, please follow these steps:
7
81. **Fork the Repository:** Click the "Fork" button in the top-right corner of the repository's page on GitHub. This will create a copy of the repository in your GitHub account.
9
102. **Clone the Repository:** Clone your forked repository to your local machine using the following command:
11
12```bash
13git clone https://github.com/<your-username>/paw.git
14```
15
163. **Create a New Branch:** Create a new branch for your contribution:
17
18```bash
19git checkout -b feature/feature-name
20```
21
22Replace feature-name with a descriptive name for your contribution.
23
244. **Make Changes:** Make your desired changes to the codebase. Ensure that your changes adhere to the project's coding style and guidelines.
25
265. **Commit Changes:** Commit your changes with a descriptive commit message:
27
28```bash
29git commit -m "Add feature or fix issue"
30```
31
326. **Push Changes:** Push your changes to your forked repository:
33
34```bash
35git push origin feature-name
36```
37
387. **Submit a Pull Request (PR):** Go to the GitHub page of your forked repository. Click on the _"New Pull Request"_ button and submit a PR with your changes. Provide a descriptive title and description for your PR, detailing the changes you've made.
39
40## Code Review Process
41
42All PRs will be reviewed by project maintainers. Feedback may be provided, and changes may be requested before the PR is merged. Contributors are expected to address any feedback promptly.
43
44## Reporting Issues
45
46If you encounter any bugs, errors, or have suggestions for improvements, please [open an issue](https://github.com/aottr/paw/issues/new) on GitHub. Provide detailed information about the issue or suggestion, including steps to reproduce, if applicable.
47
48Thank you for contributing to paw! ❤️🐾