Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@

# Contributing to Hactoberfest2024 🌿

Thank you for considering contributing to **Hactoberfest2024**! 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
- Navigate to the [Hactoberfest2024 GitHub repository](https://github.com/mlscgescoe/Hactoberfest2024).
- Click the **Fork** button to create a copy of the repository under your own GitHub account.

### 2. Clone the Repository
- Clone the forked repository to your local machine:
```bash
git clone https://github.com/your-username/Hactoberfest2024.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:
```bash
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:
```bash
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:
```bash
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 **Hactoberfest2024** 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.