Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.06 KB

Contributing.md

File metadata and controls

75 lines (54 loc) · 2.06 KB

Contributing to Blog App

Thank you for considering contributing to the Blog App! Contributions help make this project better and more robust. Whether you’re fixing bugs, improving documentation, or adding new features, your efforts are greatly appreciated.

How to Contribute

1. Fork the Repository

Start by forking the repository to your GitHub account. This creates a copy of the project under your profile.

git clone https://github.com/your-username/blog-app.git
cd blog-app

2. Create a Branch

Create a new branch for your contribution. Use a descriptive name for your branch.

git checkout -b feature/your-feature-name

3. Install dependencies:

npm install

  • Set up your .env file

  • Start the development server:

    npm run dev

4. Make Changes

Make your changes in the new branch. Follow these guidelines to ensure code quality:

  • Adhere to the existing coding style and conventions.
  • Write clear and concise commit messages.
  • Include comments where necessary for clarity.

5. Commit and Push

Once your changes are complete, commit them with a meaningful message and push them to your forked repository.

git add .
git commit -m "Add meaningful description of your changes"
git push origin feature/your-feature-name

6. Submit a Pull Request

Open a pull request to the main repository:

  • Go to the original repository on GitHub.
  • Click on the Pull Requests tab.
  • Click New Pull Request.
  • Select your branch and provide a clear description of your changes.
  • Submit the pull request.

7. Wait for Review

A project maintainer will review your pull request. Be open to feedback and make any requested changes.

We also have a discord channel.

Contributors : User names of the contributors will be added over here.

Reporting Issues : If you encounter a bug or have a feature request, please open an issue in the repository. Provide as much detail as possible, including:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)