Skip to content

Latest commit

 

History

History
154 lines (95 loc) · 4.86 KB

CONTRIBUTING.md

File metadata and controls

154 lines (95 loc) · 4.86 KB

Contributing to Midwest Pumpkins 🎃

Thank you for your interest in contributing to the Midwest Pumpkins project! We're excited to have you participate in making this open-source project even better. Whether you're fixing bugs, suggesting new features, or improving documentation, your contributions are greatly appreciated.

Please take a moment to review this guide to ensure that your contributions are well-received.

🛠 Prerequisites

Before you get started, please ensure you have the following installed on your system:

📋 Getting Started

1. Fork the Repository

Fork the repository by clicking the "Fork" button at the top of the project page.

2. Clone the Fork

After forking the project, clone your forked repository to your local machine:

git clone https://github.com/OpenCodeChicago/Midwest-Pumpkins.git

3. Navigate into the Project Directory

Move into the project folder:

cd Midwest-Pumpkins

4. Open the Project

Open the project in your code editor:

code .

5. Install Dependencies

Install all necessary dependencies:

npm install

6. Start the Development Server

Run the development server:

npm run dev

7. Create a New Branch

Create a new branch for your feature or bug fix:

git checkout -b feature/your-branch-name

8. Make Your Changes

Make sure your changes follow the project’s coding guidelines.

9. Stage and Commit Your Changes

Stage your changes and commit them with a descriptive commit message:

git add .
git commit -m "descriptive commit message"

10. Push Your Changes

Push your changes to your forked repository:

git push origin feature/your-branch-name

11. Submit a Pull Request (PR)

Go to the original repository and submit a pull request from your fork. Ensure that your PR includes a detailed explanation of the changes you made.

Pro Tip: Make sure your pull request follows the PR Template if applicable.

🚩 Contribution Guidelines

To maintain a smooth and productive workflow, please follow these guidelines:

  • Ensure that your code is well-documented and easy to understand.
  • Make sure your feature or bug fix is well-scoped and well-defined.
  • Keep your pull requests small and focused on a single topic. Large pull requests may take longer to review.
  • Ensure that your commit messages are descriptive and meaningful.
  • Check that your changes pass all existing tests, and write new tests if necessary.
  • Use the provided Kanban board to track your task's progress.

💡 Best Practices

  • Responsive Design: Remember, the project follows a mobile-first approach. All designs should be responsive and tested across different devices.
  • Code Style: We follow the Airbnb JavaScript Style Guide. Please make sure your code adheres to it.

🏷 Issue and Pull Request Labels

We use the following labels to categorize issues and pull requests:

  • hacktoberfest: Issues eligible for Hacktoberfest contributions.
  • hacktoberfest-accepted: Contributions that have been reviewed and accepted for Hacktoberfest.
  • bug: An issue related to a bug or problem in the project.
  • enhancement: A new feature or improvement suggestion.

📝 Code of Conduct

By participating, you are expected to uphold our Code of Conduct. Please read it to ensure a positive and inclusive environment for all.

🔄 Pull Request Template

When submitting a PR, follow this template to ensure your changes are clear and concise:

## Description

Please include a summary of the changes and the motivation behind them.

## Checklist

- [ ] My code follows the style guidelines of this project.
- [ ] I have performed a self-review of my code.
- [ ] I have commented on my code, particularly in hard-to-understand areas.
- [ ] I have added tests where necessary.
- [ ] My changes generate no new warnings or errors.
- [ ] I have checked that my feature works on mobile devices.

📅 Contribution Timeline

Hacktoberfest starts on October 1st! Remember, you need to complete at least four pull requests to be eligible for Hacktoberfest rewards. Try to submit your PRs progressively—don’t rush them at the last minute. Make sure your commits are meaningful and documented.

🧑‍💻 Need Help?

If you have any questions or need help getting started, feel free to ask in the Discussions, contact us by email at [email protected], or join our Discord server.

We look forward to your contributions!

Happy coding! 🎉