Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 1.84 KB
Raw

Contributing to paw

Welcome to paw! We appreciate your interest in contributing to my project.

How to Contribute To contribute to paw, please follow these steps:

  1. 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.

  2. Clone the Repository: Clone your forked repository to your local machine using the following command:

git clone https://github.com/<your-username>/paw.git
  1. Create a New Branch: Create a new branch for your contribution:
git checkout -b feature/feature-name

Replace feature-name with a descriptive name for your contribution.

  1. Make Changes: Make your desired changes to the codebase. Ensure that your changes adhere to the project's coding style and guidelines.

  2. Commit Changes: Commit your changes with a descriptive commit message:

git commit -m "Add feature or fix issue"
  1. Push Changes: Push your changes to your forked repository:
git push origin feature-name
  1. 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.

Code Review Process

All 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.

Reporting Issues

If you encounter any bugs, errors, or have suggestions for improvements, please open an issue on GitHub. Provide detailed information about the issue or suggestion, including steps to reproduce, if applicable.

Thank you for contributing to paw! ❤️🐾