Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

61 lines (46 loc) · 2.3 KB
Raw

Contributing to Busted

So you want to contribute to busted? Fantastic! Here's a brief overview on how best to do so.

What to change

Here's some examples of things you might want to make a pull request for:

  • New language translations
  • New features
  • Bugfixes
  • Inefficient blocks of code

If you have a more deeply-rooted problem with how the program is built or some of the stylistic decisions made in the code, it's best to create an issue before putting the effort into a pull request. The same goes for new features - it is best to check the project's direction, existing pull requests, and currently open and closed issues first.

Style

  • Two spaces, not tabs
  • Variables have_underscores, classes are Uppercase
  • Wrap everything in local, expose blocks of code using the module pattern
  • Review our style guide for more information.

Look at existing code to get a good feel for the patterns we use. Please run tests before submitting any pull requests. Instructions for running tests can be found in the README.

Using Git appropriately

  1. Fork the repository to your Github account.
  2. Create a topical branch - a branch whose name is succint but explains what you're doing, such as "romanian-translation"
  3. Make your changes, committing at logical breaks.
  4. Push your branch to your personal account
  5. Create a pull request
  6. Watch for comments or acceptance

Please make separate branches for unrelated changes!

Licensing

Busted is MIT licensed. See details in the LICENSE file. This is a very permissive scheme, GPL-compatible but without many of the restrictions of GPL.

New releases

  1. Create a new rockspec in the ./rockspecs folder, copied from the scm in the repo root folder.
  2. Update the line busted.version = 'x.y.z' in file ./busted/core.lua.
  3. in ./action.yml update the version number in the image tag.
  4. commit the changes, and tag it in vX.Y.Z format
  5. push the commit and the tags
  6. Edit GitHub tag to make a release and edit it changelog notes
  7. Attach rockspec and src.rock (preferably downloaded from luarocks.org so checksums match)