Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 1.43 KB

Contributing

  1. Fork the repository
  2. Create your feature branch: git checkout -b my-new-feature
  3. Make your changes and ensure they follow the project's coding standards
  4. Compile and test your changes locally
  5. Commit your changes: git commit -s -m 'Add some feature'
  6. Push to the branch: git push origin my-new-feature
  7. Create a pull request

Building and Testing

To build the project:

make all

To run tests:

make run-tests

For a full list of available make targets, run:

make help

Code Style

Please follow the coding style guidelines outlined in the project. Typically for C projects, this might include:

  • Use 4 spaces for indentation (not tabs)
  • Keep lines to a maximum of 80 characters
  • Use descriptive variable and function names
  • Comment your code where necessary

Submitting Changes

  • Ensure your code compiles without warnings
  • Run all tests and make sure they pass
  • Update documentation if you're changing functionality
  • Include comments in your code where necessary

After your pull request is merged, you can safely delete your branch.

Reporting Issues

If you find a bug or have a suggestion for improvement, please open an issue on the project's issue tracker. Provide as much detail as possible, including:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Your environment (compiler version, OS, etc.)

Thank you for contributing to this project!