--------------------------------
Contributing to the repository
--------------------------------

Your contributions, corrections and code changes are very welcome.
Contributions are made through pull requests. Please follow these steps:

- Fork the current repository to your account.
- Create a new branch named after the feature you are developing or the change
  you are making.
- Make the change on that branch.
- Create a pull request from this branch to the main branch.
- Ensure that all automated checks have passed (see below).
- Wait until your pull request is approved or commented on.
- Address all comments until the pull request is approved.
- Once the pull request is merged to the main branch, delete your branch.

Automated checks
================

When you open a pull request, GitHub Actions builds the documentation and
deploys previews to Cloudflare Pages. The workflow
:github-file:`.github/workflows/deploy-docs-cloudflare.yml` builds the site
twice, once public and once internal, and runs a leak check that fails if
internal content ends up in the public build.

If a check fails:

- Open the failing run from the **Checks** tab of your pull request.
- Most failures are Sphinx syntax errors in ``.rst`` files. Open the failing
  step log, read the reported Warning or Error, and correct it. The build is
  strict, so warnings are treated as failures.
- Push the fix to the same branch. The checks re-run automatically.

.. note::

   The documentation no longer builds on Read the Docs. The old
   ``docs/readthedocs.org:neurowaves`` check has been replaced by the GitHub
   Actions build and the Cloudflare Pages previews.