Contributing Guidelines

January 25, 2025 ยท View on GitHub

Thank you for your interest in contributing to our project! We welcome contributions from everyone.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to accntech.dev@gmail.com.

How to Contribute

Reporting Issues

  • Before creating an issue, please check if a similar issue already exists
  • Provide a clear and descriptive title
  • Include steps to reproduce the issue
  • Describe the expected behavior and what actually happened
  • Include any relevant screenshots or error messages

Pull Requests

  1. Fork the repository and create your branch from main
  2. If you've added code that should be tested, add tests
  3. Ensure the test suite passes
  4. Make sure your code follows the existing code style
  5. Write a clear and descriptive commit message, please follow the commit message convention
  6. Update documentation as needed

Development Process

  1. Create an issue describing the change you want to make
  2. Fork the repository
  3. Create a feature branch
  4. Make your changes
  5. Submit a pull request

Coding Standards

  • Follow the existing code style
  • Write clear, readable, and maintainable code
  • Comment your code when necessary
  • Keep your changes focused and atomic

Documentation

  • Update the README.md if needed
  • Add inline documentation for new functions or complex logic
  • Update any relevant documentation files

Questions?

If you have any questions, feel free to create an issue or reach out to the maintainers at accntech.dev@gmail.com.

Thank you for contributing!