Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 2.21 KB
Raw

Contributing Guidelines for software-engineering-preparation

Welcome Contributors! 🎉

Thank you for considering contributing to software-engineering-preparation! 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. Adding New Topics

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

  1. Navigate to the relevant section (e.g., algorithms, design-patterns, testing, etc.).
  2. Create a new markdown file with a descriptive name (e.g., my-new-topic.md).
  3. Write your content in the markdown file. Include explanations, examples, and code snippets.
  4. Add a brief summary of the topic to the appropriate README section.

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 software-engineering-preparation a valuable resource for aspiring software engineers. 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! 😊🚀