Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.
/ craft-grammar Public archive
forked from canonical/craft-grammar

Advanced grammar for parts

License

Notifications You must be signed in to change notification settings

syu-w/craft-grammar

 
 

Repository files navigation

Craft Grammar

This project aims to provide python interfaces for using advanced grammar in Craft Parts

License

Free software: GNU Lesser General Public License v3

Documentation:

https://craft-grammar.readthedocs.io.

Contributing

A Makefile is provided for easy interaction with the project. To see all available options run:

make help

Running tests

To run all tests in the suite run:

make tests

Adding new requirements

If a new dependency is added to the project run:

make freeze-requirements

Verifying documentation changes

To locally verify documentation changes run:

make docs

After running, newly generated documentation shall be available at ./docs/_build/html/.

Committing code

Please follow these guidelines when committing code for this project:

  • Use a topic with a colon to start the subject
  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Do not capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why (instead of how)

As an example:

endpoints: support package attenuations

Required in order to obtain credentials that apply only to a given package;
be it charm, snap or bundle.

About

Advanced grammar for parts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 96.9%
  • Makefile 3.1%