Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.21 KB

Contributing Guide

👋 Welcome! Thank you for considering contributing to this project.

📌 Purpose

This project is created for educational purposes and as part of my professional portfolio. Contributions are welcome if they help improve clarity, documentation, or functionality — especially for beginners learning Docker and CI/CD.

🧱 Project Structure

  • backend/ — Flask API
  • frontend/ — Node.js frontend
  • nginx/ — Nginx reverse proxy
  • .github/workflows/ — GitHub Actions CI/CD
  • docker-compose.yml — Local setup
  • README.md / README.ru.md — Documentation

✅ How to Contribute

  1. Fork the repository
  2. Create a branch: git checkout -b feature/your-feature-name
  3. Make changes, write clear comments
  4. Test your changes locally with Docker
  5. Commit: git commit -m "Add useful feature"
  6. Push to your fork and open a Pull Request

💬 Issues & Suggestions

Feel free to open issues for:

  • Bugs
  • Suggestions for improvement
  • Questions from beginners (they are welcome!)

📄 License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thanks again for being here and supporting open learning!