Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

44 lines (35 loc) · 2.53 KB
Raw

Contributing Guidelines for The Blog

Welcome Contributors! 🎉

Thank you for considering contributing to The Blog! Your contributions are valuable in making this project better. Here are some guidelines to help you get started:

1. Code of Conduct

Before diving into contributing, please review our Code of Conduct. We expect all contributors to adhere to these guidelines to maintain a respectful and inclusive community.

2. Getting Started

  • Fork this repository to your GitHub account.
  • Clone your forked repository to your local machine.
  • Create a new branch for your contribution (e.g., feature/add-new-topic).

3. Working on Unimplemented Feature

We welcome new topics related to software engineering, programming, and related fields. To add a new topic:

  1. Navigate to the project idea.
  2. In the project idea discussion you will find the features with their description.
  3. Now pick a feature, and start working on that.
  4. Complete your work and push to your branch and create a new PULL REQUEST.
  5. And add a discussion under Development category.
  6. First mention where you have worked (frontend or backend) in the title, and the give a colon and complete the title with feature you have worked.
  7. In discussion's body, write short summary abour your PULL REQUEST, you also give the PR link and the add it.

4. Writing Guidelines

  • Keep your explanations concise and easy to understand.
  • Use proper formatting (headings, lists, code blocks, etc.).
  • Include relevant references or external links if applicable.
  • If you’re adding code examples, ensure they are well-commented and follow best practices.

5. Submitting Your Contribution

  1. Commit your changes with a clear and descriptive commit message.
  2. Push your changes to your forked repository.
  3. Create a pull request (PR) from your branch to the main repository.
  4. Provide a detailed description of your changes in the PR description.

6. Review Process

  • Our maintainers will review your PR promptly.
  • Address any feedback or suggestions provided during the review.
  • Once approved, your contribution will be merged into the main branch.

Thank You!

Your contributions help make The Blog a valuable resource for aspiring new coder. We appreciate your time and effort!

Feel free to enhance these guidelines or add any additional sections that align with your project’s goals. Happy contributing! 😊🚀