Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 2.36 KB

Contributing to CLI Framework for Free Pascal

First off, thank you for considering contributing to CLI Framework for Free Pascal! It's people like you that make it such a great tool.

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.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include your environment details (OS, FPC version, etc.)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • A clear and descriptive title
  • A detailed description of the proposed functionality
  • Example code showing how the feature would be used
  • Explain why this enhancement would be useful
  • List any alternatives you've considered

Pull Requests

  • Fill in the required template
  • Follow the Pascal coding style
  • Include appropriate test cases
  • Update documentation for significant changes
  • End all files with a newline

Pascal Coding Style Guidelines

  • Use PascalCase for type names and method names
  • Use camelCase for variable names and parameters
  • Add meaningful comments to explain complex logic
  • Keep methods focused and reasonably sized
  • Follow Object Pascal conventions

Development Process

  1. Fork the repo and create your branch from main
  2. Make your changes
  3. Add tests if applicable
  4. Ensure the test suite passes
  5. Update documentation if needed
  6. Issue that pull request!

Testing

  • Run the test suite with runtests.pas
  • Add test cases for new functionality
  • Ensure existing tests pass

Documentation

  • Update README.md if needed
  • Add inline documentation for new code
  • Update user manual for significant changes
  • Keep technical documentation current

Questions?

  • Feel free to open an issue for discussion
  • Contact the maintainers directly

Thank you for your contribution! 🚀