Examples are always good especially if this a new feature or method.Ensure that doc strings are updated in the code itself to work with Sphinx and are correctly formatted. Ensure any changes or additions to public methods are documented.Make sure the version number is filled out and correct.We try and keep this TBD until we're ready to do a release so it's easy to catch that it needs to be updated. Make sure the date of the release matches today.Try and match the language of previous change log messages.This is a required step in making changes to the API. If you notice something was done that wasn't added to the changelog, hunt down that engineer and make them feel guilty for not doing so. This may include changes you did not make so look at the commit history and make sure we don't miss anything. Add bullet points for any changes that have happened since the previous release.Update the Changelog in the HISTORY.rst file.To run all of the tests, use the shell script run-tests.This data will be manipulated by the tests, and should not be used for other purposes. The tests will add test data to your server based on information in your config. The server and script user values must be supplied in the tests/config file.
0 Comments
Leave a Reply. |