summaryrefslogtreecommitdiff
path: root/HACKING.rst
AgeCommit message (Collapse)Author
2020-07-13HACKING.rst: add pytest.param pytest gotcha (#481)Daniel Watkins
2020-06-30Enable use of the caplog fixture in pytest tests, and add a cc_final_message ↵Daniel Watkins
test using it (#461) caplog is only available in pytest itself from 3.0 onwards. In xenial, we only have pytest 2.8.7. However, in xenial we do have pytest-catchlog available (as python3-pytest-catchlog), so we use that where appropriate.
2020-06-26HACKING.rst: add details of net refactor tracking (#456)Daniel Watkins
2020-06-24net/networking: remove unused functions/methods (#453)Daniel Watkins
Namely, is_connected, is_wireless and is_present. None of these are used in the cloud-init codebase, so remove the dead code (instead of refactoring it).
2020-06-23distros.networking: initial implementation of layout (#391)Daniel Watkins
This commit introduces the initial structure for the "cloudinit.net -> cloudinit.distros.networking Hierarchy" refactor, as detailed in [0]. It also updates that section with some changes driven by this initial implementation, as well as adding a lot more specifics to it. [0] https://cloudinit.readthedocs.io/en/latest/topics/hacking.html#cloudinit-net-cloudinit-distros-networking-hierarchy
2020-06-22HACKING.rst: add strpath gotcha to testing gotchas section (#446)Daniel Watkins
Co-authored-by: Rick Harding <rharding@mitechie.com>
2020-06-04New feature flag functionality and fix includes failing silently (#367)James Falcon
Build time feature flags are now defined in cloudinit/features.py. Feature flags can be added to toggle configuration options or deprecated features. Feature flag overrides can be placed in cloudinit/feature_overrides.py. Further documentation can be found in HACKING.rst. Additionally, updated default behavior to exit with an exception if #include can't retrieve resources as expected. This behavior can be toggled with a feature flag. LP: #1734939
2020-05-26HACKING.rst: introduce .net -> Networking refactor section (#384)Daniel Watkins
2020-05-22HACKING: mention that .github-cla-signers is alpha-sorted (#380)Daniel Watkins
Hopefully this will save some ~pointless round trips on CLA PRs.
2020-05-11HACKING.rst: change contact info to Rick Harding (#359)lucasmoura
2020-05-11HACKING.rst: guide people to add themselves to the CLA file (#349)Daniel Watkins
This (a) gives people an easy way of getting a commit into the codebase, and (b) saves us from having to explain this process (or do it ourselves) for every new contributor.
2020-05-11HACKING.rst: more unit testing documentation (#354)Daniel Watkins
Specifically: * include warning against general use of mock assert methods (and suggestions on how to replace them) * add guidelines on test decorator/param ordering * add test guideline for module-level mock variables
2020-04-23More unit test documentation (#314)Daniel Watkins
* HACKING.rst: add list of available pytest fixtures * HACKING.rst: capture common mock naming pattern in codebase
2020-04-14HACKING.rst: add pytest version gotchas section (#311)Daniel Watkins
And document that we can't yield in pytest.fixture functions due to the age of xenial's pytest.
2020-03-31HACKING.rst: reorganise/update CLA signature info (#297)Daniel Watkins
* Split the "existing contributors" information out to a separate section * Update the "Do these things once" CLA information for the current process
2020-03-31HACKING.rst: add note about variable annotations (#295)Daniel Watkins
2020-03-30HACKING.rst: add Type Annotations design section (#293)Daniel Watkins
2020-03-26HACKING.rst: add examples of the two test class types (#278)Daniel Watkins
2020-03-25HACKING.rst: add Unit Testing design section (#277)Daniel Watkins
2020-03-24HACKING.rst: add links to new Code Review Process doc (#276)Daniel Watkins
Co-authored-by: Joshua Powers <josh.powers@canonical.com>
2020-01-29HACKING.rst: update CLA link (#199)Daniel Watkins
2019-12-19HACKING.rst: clarify that everyone needs to do the LP->GH dance (#130)Daniel Watkins
The previous language suggested that only people who had signed the CLA previously needed to prove their GH identity, which is not the case.
2019-12-17doc: specify _ over - in cloud config modulesJoshua Powers
Start a design decision area in HACKING to capture highlevel decisions. First example is to capture the use of _ over - in cloud config modules. LP: #1293254
2019-11-07doc: update launchpad git refs to githubRyan Harper
2018-12-18HACKING.rst: change contact info to Josh PowersScott Moser
In the Hacking doc, change the contact information for the contributors agreement to reference Josh Powers rather than Scott Moser.
2018-01-25HACKING.rst: mention setting user name and email via git config.Scott Moser
Just include mention of setting user name and email when first setting up git.
2017-04-12HACKING.rst: more info on filling out contributors agreement.Scott Moser
When signing the Contributors agreement, the user is prompted to provide a 'Project contact' or 'Canonical Project Manager'. Just update the HACKING.rst document to tell them what to put there.
2016-11-10doc: make the RST files consistently formated and other improvements.Scott Moser
The biggest things here are: * move doc/sources/*/README.rst to doc/rtd/topics/datasources This gives each datasource a page in the rtd docs, which make it easier to read. * consistently use the same header style throughout. As suggested at http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html use: # with overline, for parts * with overline, for chapters =, for sections -, for subsections ^, for subsubsections “, for paragraphs Also, move and re-format vendor-data documentation to rtd.
2016-11-01doc: improve HACKING.rst fileScott Moser
Put a bit more information and a few style fixes in HACKING.rst.
2016-08-03Update build tools to work with gitLars Kellogg-Stedman
- Update HACKING.rst to include git instructions - update MANIFEST.in and .gitignore to ignore git-related things - replaced tarball generation scripts with git-based script - have the spec files correctly identify themselves as cheetah templates - make brpm work with git
2014-08-26Remove pylintJay Faulkner
pylint was not passing, and per smoser in IRC pylint can/should be removed.
2013-02-04Add initial docs about datasources.harlowja
Start moving the current README for datasources to a RST format and include those files in the rtd site. LP: #1113650