Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 2.28 KB

contributing.md

File metadata and controls

58 lines (44 loc) · 2.28 KB
Raw

Contributing to WildGuard 🌿

Thank you for considering contributing to WildGuard! We appreciate your interest in making a meaningful impact on animal welfare and environmental conservation. This document will guide you through the contribution process and help ensure that your contributions fit within the project’s goals and guidelines.

How to Contribute 🛠️

1. Fork the Repository

2. Clone the Repository

  • Clone the forked repository to your local machine: 
    git clone https://github.com/your-username/WildGuard.git
cd WildGuard

3. Create a Branch

  • It's a good practice to create a new branch for each feature or fix you're working on: 
    git checkout -b feature-branch-name

4. Make Your Changes

  • Add new features, fix bugs, or improve documentation as needed.
  • Ensure your code follows the coding standards and structure of the project.
  • Test your changes to confirm everything works as expected.

5. Commit Your Changes

  • Use clear and concise commit messages to describe your changes: 
    git add .
git commit -m "Added feature X or fixed issue Y"

6. Push the Changes

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

7. Submit a Pull Request (PR)

  • Once your changes are complete, open a Pull Request (PR) from your feature branch to the main branch of the WildGuard repository.
  • In your PR description, provide a brief summary of what your changes do and reference any related issues.
  • Wait for the maintainers to review your submission. Feedback may be provided, and changes might be requested before your PR can be merged.

Contribution Guidelines 📜

Please follow these guidelines to make sure your contributions are aligned with the project’s standards:

Code of Conduct

  • Be respectful and considerate to others.
  • Ensure that all interactions and discussions remain friendly and constructive.

Code Style

  • Stick to HTML, CSS, and JavaScript best practices.
  • Keep code clean, well-documented.