Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 4 KB

CONTRIBUTING.md

File metadata and controls

85 lines (59 loc) · 4 KB

Contributing to SEAL

Thank you for your interest in contributing to SEAL! Your contributions are essential to the success of this project. The following is a set of guidelines to help you contribute to SEAL. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on the GitHub Issues page. Before reporting a bug, please check if it has already been reported.

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one.
  • Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue to discuss it before making changes. This ensures that we can coordinate efforts and avoid duplicating work.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a detailed description of the suggested enhancement in the issue.
  • Explain why this enhancement would be useful to most SEAL users.
  • Describe any alternative solutions you have considered.

Contributing Code

We welcome contributions to the SEAL codebase! To contribute code, please follow these steps:

  1. Fork the Repository: Create a personal copy of the repository by clicking the 'Fork' button.
  2. Clone the Repository: Clone your forked repository to your local machine using the command: 
    git clone https://github.com/Autism-Technology-Research-Syndicate/SEALApplication.git
  3. Create a Branch: Create a new branch for your feature or bug fix. 
    git checkout -b feature-name
  4. Make Changes: Implement your feature or fix.
  5. Commit Changes: Commit your changes with a descriptive commit message. 
    git commit -m "Description of changes"
  6. Push Changes: Push your changes to your forked repository. 
    git push origin feature-name
  7. Create a Pull Request: Submit a pull request to the main repository with a detailed explanation of your changes.

Code Style

To maintain consistency and readability, please adhere to the following code style guidelines:

  • Use descriptive variable and function names.
  • Write clear and concise comments.
  • Follow consistent indentation and formatting.
  • Ensure that your code passes all tests and does not introduce new warnings or errors.

Code of Conduct

By participating in this project, you agree to abide by the Contributor Covenant Code of Conduct. Please read it to understand the expectations for contributing to SEAL.

Getting Help

If you need help or have questions about contributing, feel free to reach out by opening an issue or contacting us at [email protected].

Thank you for your contributions! Together, we can make SEAL a valuable tool for personalized special education.

Current Priorities

We are focusing on the following tasks:

Core Features

  • Integrate the SQLite Database to store experimental data during the runtime and analysis phase
  • Take and store sensor data from the mobile device during a given time interval
  • Import the necessary AI models from Vladmandic/Human to analyze the data during educational testing and store the responsiveness
  • Create a model to analyze inputs in curriculum and see statistics on performance
  • Way to cycle different curriculum combinations and optimize the best one for the student
  • Way to export learning style

Bug Fixes

Documentation