Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

88 lines (58 loc) · 2.7 KB
Raw

Contributing to PurrfectTechnologies 🐾

We’re thrilled that you’d like to contribute to PurrfectTechnologies! Whether it’s bug fixes, new features, documentation improvements, or something else, your help is greatly appreciated. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

1. Fork the Repository

Start by forking the repository you want to contribute to. This will create your own copy of the project where you can make your changes.

Click on the "Fork" button on the repository page. Clone your forked repository to your local machine:

Copy code
git clone https://github.com/your-username/repo-name.git
cd repo-name

2. Create a Branch

Create a new branch for your contribution to keep changes organized:

Copy code
git checkout -b feature-or-bugfix-name

3. Make Changes

Work on your feature or bug fix. Please follow our code style and guidelines (see Code Standards).

4. Commit Your Changes

Once you're happy with your changes, commit them with a clear and descriptive message:

Copy code
git add .
git commit -m "Add detailed commit message"

5. Push Your Changes

Push your branch to your fork on GitHub:

Copy code
git push origin feature-or-bugfix-name

6. Submit a Pull Request

Go to the original repository and submit a pull request from your branch. Be sure to:

  • Write a descriptive title.
  • Explain the changes you made and why they’re important.
  • Reference any issues or feature requests your changes address.

Reporting Bugs

If you find any bugs, please help us by reporting them. Create an issue using the template and provide as much detail as possible, including:

  • Steps to reproduce the issue.
  • Expected vs. actual behavior.
  • Any error messages or screenshots.

Requesting New Features

If you have an idea for a new feature, we’d love to hear it! Open a feature request as an issue, explaining:

  • What problem the feature will solve.
  • How you envision the feature working.
  • Any alternatives you’ve considered.

Code Standards

To keep our codebase clean and consistent, please adhere to the following guidelines:

  • Style: Follow the existing style in the repository (e.g., spacing, variable naming).
  • Documentation: Ensure your code is well-documented with comments where necessary.
  • Testing: If applicable, write tests for any new functionality you add.
  • Commit Messages: Use clear and concise commit messages.

Community Guidelines

  • Be respectful and constructive in your interactions.
  • Provide meaningful feedback when reviewing others’ code.
  • Please avoid creating issues or pull requests for minor changes like typo fixes unless there’s a clear need.