Skip to content

Added information about test system #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added information about test system #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/gitworkflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,11 @@ implementing your feature.

This will result in an extra merge commit.

#. Test whether your updated feature branch still works as expected (having
regression tests for your feature can help here).
#. Test whether your updated feature branch still works as expected
(having regression and/or unit tests for your feature can help
here). See the DFTB+ `code notes
<https://github.com/dftbplus/dftbplus/tree/main/doc/dftb%2B/code>`_
for how to add new tests for your feature branch.

#. Publish your feature branch to your personal repository on GitHub::

Expand All @@ -278,6 +281,13 @@ implementing your feature.
#. Issue a pull request on GitHub for your `some-new-feature` branch (look for
the upwards arrow in the left menu).

#. The github actions will run code tests on your pull request. You
may receive emails about these tests if they fail. In this case,
visit your pull request and check the build and testing history for
the relevant actions. In several cases, you can download a detailed
archive of the failed test outputs. Fix and problems and push your
changes to your feature branch.

#. Wait for the comments of other developers, apply any fixes you are asked to
make, and push the changes to your feature branch on GitHub.

Expand Down