Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (48 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

71 lines (48 loc) · 2.18 KB

Contributing directly to Student Performance Predictor AI

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Student Performance Predictor AI. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

🚀 Getting Started

  1. Fork the repository on GitHub.
  2. Clone the project to your own machine.
  3. Commit changes to your own branch.
  4. Push your work back up to your fork.
  5. Submit a Pull Request so that we can review your changes.

🛠️ Development Setup

Please refer to the README.md for detailed instructions on setting up the project using Docker or manually.

📏 Code Style & Standards

We strive to keep the codebase clean and readable.

Python (Backend & ML)

  • Follow PEP 8 guidelines.
  • Use meaningful variable and function names (snake_case).
  • Add docstrings to complex functions.
  • Run type checking (mypy) if possible.

JavaScript/React (Frontend)

  • Use ES6+ syntax.
  • Prefer functional components and Hooks.
  • Keep components small and reusable.
  • Use prettier for formatting.

💌 How to Report a Bug

If you find a security vulnerability, please do NOT open an issue. Email the maintainer directly.

For normal bugs, open an issue and include:

  • A clear, descriptive title.
  • Steps to reproduce the bug.
  • Expected behavior vs. actual behavior.
  • Screenshots (if applicable).
  • Your environment (OS, Browser, etc.).

💡 Suggesting Enhancements

We love creative ideas! When suggesting an enhancement:

  • Check if the idea has already been proposed in Discussions or Issues.
  • Clearly explain why this feature would be useful.
  • If possible, provide a mock-up or code example.

📥 Pull Request Process

  1. Ensure you have self-reviewed your code.
  2. Update documentation if you have changed APIs or features.
  3. Add a description of your changes in the PR.
  4. Link any related issues (e.g., Closes #123).
  5. Wait for a maintainer to review your PR. We try to review within 48 hours!

Thank you for being part of our community! ❤️