Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

67 lines (51 loc) · 2.48 KB

Contributing to SDLC Beginners Guide

Thank you for considering contributing to the SDLC Beginners Guide! Your support is invaluable in making this project a comprehensive resource for those new to software development.

📌 How to Contribute

We welcome contributions from everyone, whether it's fixing a typo, adding new content, or improving existing sections. Here's how you can get started:

1. Reporting Issues

If you find any bugs, typos, or have suggestions for improvements:

  • Open an Issue: Create a new issue.
  • Please ensure your issue hasn’t been reported already.

2. Submitting Pull Requests

Ready to contribute? Follow these steps:

  1. Fork the Repository: Click the "Fork" button at the top right of this page.
  2. Clone Your Fork: 
    git clone https://github.com/your-username/sdlc-beginners-guide.git
  3. Create a New Branch: 
    git checkout -b feature/your-feature-name
  4. Make Your Changes: Add new content or fix existing ones.
  5. Commit Your Changes: 
    git commit -m "Brief description of your changes"
  6. Push Your Branch: 
    git push origin feature/your-feature-name
  7. Open a Pull Request: Go to your forked repo and click the "Compare & pull request" button.

3. Code Style

  • Maintain consistency with existing content.
  • Write clear, concise, and well-documented content.
  • Organize files logically and update the relevant sections.

4. Adding New Content

  • For SDLC phases, add your content in the phases/ folder.
  • For SDLC models, add to the relevant sub-folder under models/:
    • Create or update model.md (theory) and example.md (real-world examples).

5. Documentation

  • Ensure the README.md is updated if your changes affect the structure or flow.
  • Add any new content or resources to keep the documentation helpful.

📚 Additional Resources

  • Refer to our README.md for an overview of the project.
  • Join the ongoing discussions to share your ideas and suggestions.

🤝 Code of Conduct

We expect all contributors to be respectful and supportive. By contributing, you agree to follow our Code of Conduct. Please be kind and inclusive.

📬 Questions or Feedback?

If you have any questions, feel free to reach out to the project maintainer:
📧 Email: [email protected]

Happy contributing! 🚀