Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (44 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 1.56 KB

Contributing to NeuroCode

Thank you for your interest in contributing to NeuroCode – a cognitive AI framework for understanding code through neural memory simulation.

We welcome contributions of all kinds, including:

  • Bug fixes
  • Feature implementations
  • Code optimization
  • Documentation improvements
  • Research insights

Getting Started

1. Clone the repository

git clone https://github.com/FalahMsi/neurocode.git
cd neurocode

2. Set up a virtual environment

python -m venv .venv
.venv\Scripts\activate  # For Windows
pip install -r requirements.txt

3. Run the project

python main.py

Contribution Guidelines

  • Use clear and consistent naming conventions.
  • Write concise and meaningful commit messages.
  • Format your code using a linter like black.
  • Avoid including large data files in your PRs.

Pull Requests

  1. Fork the repository.
  2. Create a new branch from master.
  3. Make your changes.
  4. Push to your fork and submit a pull request.
  5. Describe your changes clearly in the PR description.

We will review your PR and collaborate if improvements are needed.

Reporting Issues

If you encounter bugs or have suggestions, open an issue here. Please include:

  • Clear description of the problem
  • Steps to reproduce
  • Environment info (OS, Python version)

License

By contributing, you agree that your code will be licensed under the MIT License.

We're excited to build NeuroCode with your help. Let's make cognitive AI for code a reality!