Skip to content

Latest commit

 

History

History
114 lines (79 loc) · 2.67 KB

Contribution.md

File metadata and controls

114 lines (79 loc) · 2.67 KB

🤝 Contributing to HopesAlive

Thank you for considering contributing to HopesAlive! We welcome contributions of all kinds, from bug fixes and feature enhancements to documentation improvements and new ideas. This guide will help you get started.

💡 How Can You Contribute?

Bug Reports

  • Check the issue tracker to see if the bug has already been reported.
  • If not, create a new issue with a clear title and detailed description.
  • Include steps to reproduce the issue, along with relevant screenshots or logs.

Feature Requests

  • Open an issue tagged as feature request to suggest a new feature.
  • Provide a clear description of your idea, its use case, and how it can improve the project.

Code Contributions

  • Work on issues labeled as help wanted or good first issue.
  • Add new features, optimize the existing codebase, or fix bugs.
  • Write tests for your code to ensure everything functions as expected.

Documentation Improvements

  • Review and enhance the project documentation.
  • Ensure the README and other files are accurate and up-to-date.

🚀 Getting Started

Fork the Repository

  • Click the "Fork" button in the top right corner of the repository to create your own copy.

Clone Your Fork

-git clone https://github.com/Your-Name/HopesAlive.git
-cd HopesAlive

Set Upstream Remote

  • To keep your fork updated with the original repository
git remote add upstream https://github.com/MadhavDhatrak/HopesAlive.git

Create a Branch

  • Create a new branch for your contribution
git checkout -b feature-name

Make Your Changes

  • Follow the project’s coding style.
  • Test your changes locally to ensure everything works as expected.

Commit Your Changes

  • Use clear and concise commit messages:
git add .
git commit -m "Brief description of changes"

Push Your Changes

  • Push your branch to your forked repository:
git push origin feature-name

Create a Pull Request

  • Go to the Pull Requests section of the repository.
  • Click New Pull Request and select your branch.
  • Provide a detailed description of your changes.

⚙️ Coding Guidelines

  • Use consistent naming conventions and code formatting.
  • Write meaningful variable and function names.
  • Keep the codebase clean and well-structured.
  • Include comments where necessary for better readability.

✅ Code of Conduct

  • Be respectful and inclusive in all your interactions.
  • Provide constructive feedback and work collaboratively.
  • Avoid making unrelated changes in your pull request.

Need help? Feel free to reach out via Discussions. Together, we can revolutionize animal rescue!