Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 1.24 KB
Raw

Contributing

Hey! Thanks for your interest in improving casing! There are plenty of ways you can help!

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Submitting an issue

Please provide us with an issue in case you've found a bug, want a new feature, have an awesome idea, or there is something you want to discuss.

Submitting a Pull Request

Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Running the tests

The tests are written using minitest. You can run them using sbt test.

Publishing

At the moment the publishing process is manual.

  1. Raise the version of casing in build.sbt
  2. Add a new section to CHANGELOG.md
  3. create a commit for the version bump (version v0.1.0)
  4. Create a git tag (git tag v0.1.0)
  5. Run sbt publishSigned for every version (2.12, 2.13, 3)
  6. Use https://s01.oss.sonatype.org/ to promote the artifacts. (Select the project, click Close from the menu, and then Release.)

I'm not sure if it's possible to automate this process, but I'll be happy to learn about it.