Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (42 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 2.45 KB
Raw

Contributing to Project Luis 🛡️

First off, thank you for considering contributing to Project Luis! It's people like you that make Luis a better tool for everyone.

How Can I Contribute?

Reporting Bugs

  • Check the existing issues to see if it's already been reported.
  • If not, open a new issue using the Bug Report template.

Suggesting Enhancements

  • Open a new issue using the Feature Request template.
  • Explain the "Why" and "How" of your proposal.

Pull Requests

  1. Fork the repository.
  2. Clone it locally: git clone https://github.com/your-username/project-Luis.git
  3. Branch: Create a feature branch: git checkout -b feature/amazing-feature
  4. Build: Run npm install and ensure tests pass.
  5. Commit: Keep your commits clean and descriptive.
  6. Push: git push origin feature/amazing-feature
  7. PR: Open a Pull Request to the main branch.

Local Development Setup

Project Luis requires:

  • Node.js v18+
  • SQLite (local storage)
npm install
node server.js

🎓 Path to Maintenance

We believe in shared governance and rewarding sustained contribution. Our pipeline for moving from a newcomer to a core decision-maker is transparent:

1. Contributor (Level 1)

  • Requirement: Your first merged Pull Request.
  • Goal: Familiarize yourself with the "14 Layers of Defense" and the Polymorphic AST Challenge engine.

2. Reviewer (Level 2)

  • Requirement: 5+ high-quality PRs merged OR providing helpful, technical reviews on 10+ PRs.
  • Responsibility: You are invited to review incoming community PRs. Your approval is a strong signal for maintainers.

3. Core Maintainer (Level 3)

  • Requirement: Consistent contribution over 3+ months and deep expertise in a specific module (e.g., Cryptographic Challenges or IP-Lock logic).
  • Responsibility: You have write access to the repository and lead architectural decisions.

🛡️ Luis Guardian (Automated Mentorship)

Please note that every Pull Request is audited by Project Luis's automated "Surgical Verification" pipeline. If our automated Guardian leaves a failing check on your PR, don't worry! It is designed to act as an automated mentor. Read its comments, fix the identified vulnerabilities, and push again.

Community

Join our Discussions to talk about the future of structural security!

Directed by Anson (@ansonsaju)