Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (42 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 1.53 KB

Contributing to safe-rm

Thank you for your interest in contributing to safe-rm! This guide will help you get started.

How to Contribute

Reporting Bugs

  • Check existing issues to avoid duplicates.
  • Open a new issue with a clear title and description.
  • Include steps to reproduce the bug, expected behavior, and actual behavior.
  • Include your OS, Python version, and Node.js version.

Suggesting Features

  • Open an issue describing the feature and its use case.
  • Explain why this feature would benefit the project.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a feature branch from main: git checkout -b feature/your-feature
  3. Make your changes with clear, descriptive commits.
  4. Ensure any new code has appropriate tests.
  5. Submit a pull request against main.

Development Setup

Server (Node.js)

cd server
npm install
cp ../.env.example .env
# Edit .env with your settings
npm run dev

Client (Python)

cd client
pip install -r requirements.txt

Code Style

  • JavaScript/Node.js: Use consistent formatting. Prefer const over let.
  • Python: Follow PEP 8.

Commit Messages

  • Use the imperative mood ("Add feature" not "Added feature").
  • Keep the first line under 72 characters.
  • Reference issue numbers where applicable.

Code of Conduct

Be respectful and constructive. We are committed to providing a welcoming and inclusive experience for everyone.

License

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