CONTRIBUTING.md

Contributing to Gradebook Management System

Table of Contents

• Contributing to Gradebook Management System
  • Table of Contents
  • Code of Conduct
  • Installation & Getting Started
  • Bug Reports
  • Feature Requests
  • Pull Requests (PR's)
  • Other
  • Code Guidelines
  • Community Expectations
  • License

Code of Conduct

We expect all contributors to follow our Code of Conduct. Please read the full text to ensure that you understand and adhere to the guidelines.

Installation & Getting Started

To get started, you'll need to:

1. Clone or fork the repository.

2. This project uses CMake and CMakeLists.txt, run the CMakeLists while in the repository project root with the cmake command, Either cmake -B build or cmake .. will work.

Bug Reports

We accept bug reports. If possible, use the GitHub UI to assign yourself to the Bug Report (Issues) task, pick appropriate labels and link an issue to the Bug Report. If you are not able to do those things, you can request them in a comment. Try and describe what issue you are having, including any hardware, compilers, operating system that may affect the bug. More complete Bug Reports (Issues) will allow us to triage the Bug Report (Issue) you have submitted.

If you encounter a bug or issue, please follow these steps to report it:

1. Search the issue tracker to see if the issue has already been reported.
2. If the issue hasn't been reported, create a new issue and provide a clear, concise description of the problem.
3. Include steps to reproduce the issue, any error messages or logs, and information about your system and environment.

Feature Requests

Feature Requests are always welcomed for new features.

To propose an enhancement, please create a new issue in the issue tracker and include the following information:

1. A clear, concise description of the enhancement.
2. The motivation and use cases for the enhancement.
3. Examples or mockups of how the enhancement would work.

This is still under development so if you find it is missing features you would like, please sumbit them with

Pull Requests (PR's)

Please make a commit change or PR branch with an appropriate name for change and PR back to main. Include a brief description of what you changed. If possible, use the GitHub UI to assign yourself to the PR task, pick appropriate labels and link an issue to the PR. If you are not able to do those things, you can request them in a comment. More complete PR's will allow us to triage merging and reviews.

When submitting a pull request, please follow these guidelines:

1. Ensure that your changes are based on the latest version of the main branch.
2. Describe the changes you've made in detail, and reference any related issues.
3. Make sure your code follows our code guidelines.
4. Add tests for any new functionality or bug fixes.
5. Ensure that all unit, e2e, integration, etc. tests pass before submitting your pull request.

Other

Complete Five (5) successful merges to the project and you can be invited to be a contributor/collaborator.

Code Guidelines

• Follow the coding style and conventions used throughout the project.
• Keep your code clean, modular, and well-documented.
• Write meaningful commit messages that describe the changes you've made.
• Keep your changes focused and avoid mixing unrelated changes in a single pull request.

Community Expectations

We expect all contributors to:

• Be respectful and considerate of others.
• Provide constructive feedback and collaborate effectively.
• Recognize and thank others for their contributions.
• Adhere to our Code of Conduct.

License

These are all licensed under the MIT license which is included with this repository