Add CONTRIBUTING.md

[asiakay]

Contributing to History Fact App

Thank you for your interest in contributing to the History Fact App! We appreciate your time and effort in making this project better. This document provides guidelines to help you get started.

---

Table of Contents

1. How Can I Contribute?
   • Reporting Bugs
   • Suggesting Features
   • Contributing Code
2. Code Guidelines
3. Development Workflow
4. Pull Request Checklist
5. Community Standards

---

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by following these steps:

1. Search existing issues: Check if the bug has already been reported.
2. Open a new issue: If not, create a new bug report issue.
3. Include details:
   • A clear description of the bug.
   • Steps to reproduce the issue.
   • Environment details (e.g., OS, browser version).

Suggesting Features

Have an idea to enhance the project? We�d love to hear about it!

1. Search existing issues: See if the feature has already been suggested.
2. Open a new issue: Use the feature request template.
3. Describe your idea:
   • What problem does this feature solve?
   • How would it work?

Contributing Code

If you�d like to fix a bug or add a new feature:

1. Check existing issues: Look for issues labeled good first issue or help wanted.
2. Fork the repository: Learn how to fork a repo.
3. Work on your changes: Follow the development workflow below.
4. Submit a pull request: See the Pull Request Checklist.

---

Code Guidelines

• Coding Style:
  • Follow the existing coding conventions in the project.
  • Use ESLint for JavaScript linting and Prettier for consistent formatting.
• File Organization:
  • Place components, pages, and utilities in their respective directories (src/components, src/pages, src/utils).
• Commit Messages:
  • Use clear and descriptive commit messages.
  • Follow this format:

    [type] Short description
    
    - Longer description of changes (if necessary).
    

    Examples of commit types:
    • feat: New feature.
    • fix: Bug fix.
    • docs: Documentation updates.
    • style: Code formatting changes.
    • test: Adding or updating tests.

---

Development Workflow

1. Clone the Repository:

   git clone https://github.com/asiakay/history-fact-app.git
   cd history-fact-app

2. Create a New Branch:

   • Name your branch based on the feature or fix, e.g.:

     git checkout -b feature/add-dark-mode

3. Install Dependencies:

   • Make sure you have Node.js installed. Then, run:

     npm install

4. Run the App Locally:

   npm start

5. Make Changes:

   • Implement your feature or bug fix.
   • Write tests if applicable.

6. Run Tests:

   • Ensure all tests pass before submitting:

     npm test

7. Commit and Push:

   • Stage and commit your changes:

     git add .
     git commit -m "feat: Add dark mode"
     git push origin feature/add-dark-mode

8. Submit a Pull Request:

   • Go to the repository on GitHub and click "New Pull Request".
   • Add a clear title and description of your changes.

---

Pull Request Checklist

Before submitting a pull request, ensure the following:

• Your code follows the project’s style guidelines.
• Tests have been added/updated for your changes.
• All tests pass (npm test).
• Documentation has been updated (if needed).
• Your branch is up-to-date with main.

---

Community Standards

• Be respectful and inclusive.
• Provide constructive feedback during code reviews.
• Avoid using offensive or inappropriate language.
• Follow our Code of Conduct.

---

Thank you for contributing to the History Fact App! Your efforts make this project possible. If you have any questions, feel free to reach out by creating a new discussion.