Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (47 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 1.91 KB

Contributing to IOTA Voting System

Thank you for considering contributing to the IOTA Voting System! This document outlines the process for contributing to this project.

Code of Conduct

By participating in this project, you agree to abide by our code of conduct. Please be respectful and considerate of others.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on GitHub with the following information:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots if applicable
  • Environment details (browser, OS, etc.)

Suggesting Features

We welcome feature suggestions! Please create an issue with:

  • A clear, descriptive title
  • A detailed description of the proposed feature
  • Any relevant mockups or examples
  • Why this feature would be beneficial

Pull Requests

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature-name)
  3. Make your changes
  4. Run tests to ensure they pass
  5. Commit your changes (git commit -m 'Add some feature')
  6. Push to the branch (git push origin feature/your-feature-name)
  7. Open a Pull Request

Pull Request Guidelines

  • Follow the coding style of the project
  • Include tests for new features or bug fixes
  • Update documentation as needed
  • Keep pull requests focused on a single change
  • Link any relevant issues

Development Setup

  1. Clone the repository
  2. Run ./setup.sh to set up the project
  3. Follow the instructions in the README.md file

Testing

  • Run backend tests: cd backend && npm test
  • Run frontend tests: cd frontend && npm test

Documentation

Please update documentation when making changes:

  • Update README.md for user-facing changes
  • Update code comments for technical changes
  • Update API documentation for API changes

License

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