Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (53 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 2.12 KB

Contributing to Openln-Engine

Thank you for your interest in contributing to Openln-Engine, an AI-Driven Personalized Learning & Goal Tracking System!

We welcome contributions from everyone. Please follow the guidelines below to help us keep the project consistent and easy to collaborate on.

🚀 How to Contribute

1. Reporting Issues

If you find a bug or have an idea for an improvement, please open an issue with:

  • A clear title describing the issue
  • Steps to reproduce (for bugs)
  • Expected vs. actual behavior
  • Screenshots or logs (if applicable)

2. Suggesting Features

Have an idea to make Openln-Engine better? Open a feature request issue and include:

  • Your motivation and use case
  • Example scenarios
  • Any relevant references

3. Making Pull Requests

We appreciate code contributions! To submit a pull request:

  1. Fork this repo and clone your fork.
  2. Create a new branch from main for your changes.
  3. Make your changes and add tests as appropriate.
  4. Ensure your code passes all checks and is well-documented.
  5. Submit a pull request—describe your changes and reference any related issues.

PR Checklist

  • Code is clean and well-commented
  • All tests pass
  • Documentation updated (if needed)
  • Related issue(s) referenced

🛠️ Development Setup

git clone https://github.com/Openln-git/Openln-Engine.git
cd Openln-Engine
# Install dependencies (specify the manager if needed, e.g. npm or yarn)
npm install
# Run tests
npm test

💡 Code Style

  • Use JavaScript best practices
  • Write clear commit messages
  • Follow existing code structure and conventions
  • Add comments where necessary

🙋‍♂️ Need Help?

📜 License

By contributing, you agree your work will be licensed under the project’s license.

Thank you for making Openln-Engine better!