Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

65 lines (47 loc) · 2.07 KB

Contributing to ProgTheta-Blog

Thank you for considering contributing to ProgTheta-Blog! Your contributions are valuable in improving and developing this project.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Reporting Issues
  4. Submitting Pull Requests
  5. Development Setup
  6. Style Guides
  7. License

Code of Conduct

Please read our Code of Conduct to understand the expected behavior when contributing to this project.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue in the Issues section. Include as much detail as possible to help us resolve the issue quickly.

Suggesting Enhancements

If you have ideas for new features or improvements, feel free to create an issue or discuss it in the existing issues section. Your feedback is crucial for the project's growth.

Reporting Issues

  1. Check existing issues to ensure your issue hasn't already been reported.
  2. Open a new issue with a clear and descriptive title.
  3. Provide detailed information on the bug or feature request, including steps to reproduce the issue if applicable.

Submitting Pull Requests

  1. Fork the repository and create your branch from main.
  2. Install dependencies (see Development Setup section).
  3. Make your changes with clear and concise commit messages.
  4. Ensure the code passes all tests.
  5. Submit your pull request to the main branch.

Development Setup

To set up the project locally:

  1. Clone the repository: 
    git clone https://github.com/anikakash/ProgTheta-Blog.git
cd ProgTheta-Blog
  2. Install server dependencies: 
     cd backend
 npm install
  3. Install client dependencies: 
    cd ../Frontend
 npm install
  4. Start the server and client:
    cd ../backend
    npm run dev
    cd ../Frontend
    npm start