Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
122 lines (85 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

122 lines (85 loc) · 3.2 KB

Contributing

First off, thanks for taking the time to contribute! ❤️

All contribution types are welcome: bug reports, feature ideas, docs updates, tests, and code improvements. 🎉

Table of Contents

I Have a Question

Before asking a question:

  • Read the official documentation.
  • Check existing issues.
  • Check discussions.
  • Search the internet for existing answers.

If you still need help, open a discussion or a question issue with your relevant context.

I Want To Contribute

Contributions of all sizes are welcome. Keep changes focused and small. All contributions are licensed under the LICENSE.

Before opening a PR:

  • For larger changes, start with an issue or discussion first.
  • Prefer one clear purpose per PR.
  • Include related tests/ updates when behavior changes.

Reporting Bugs

Before submitting a bug report, read the official documentation, check discussions and existing issues, and search the internet for similar reports or fixes to avoid duplicates and continue existing threads.

When reporting a bug, include:

  • Steps to reproduce.
  • Expected result and actual result.
  • Lua version and platform details.
  • Minimal example when possible.

Suggesting Enhancements

For enhancements, read the official documentation, check discussions and existing issues to avoid duplicate requests, then open an issue and include:

  • The problem you want to solve.
  • The proposed behavior.
  • Why it helps most users.
  • Any alternatives you considered.

Your First Code Contribution

Testing

Tests live in tests/ (named <name>.test.lua). Add or update tests there when behavior changes.

Run tests with Busted:

# All tests
busted

# A specific test file
busted tests/<name>.test.lua

Linting

Run lint checks before opening a PR:

Improving The Documentation

  • The documentation website code and guides live in the bluelua.github.io repository.
  • For website updates, guides, or layout improvements, please open pull requests there.
  • For inline API documentation changes, update the annotations under the types/ directory (or the docs directory for manual tutorials and guides that are not autogenerated). Do not write documentation directly in the source code.

Styleguides

Commit Messages

This project follows Conventional Commits 1.0.0.