CONTRIBUTING.md

Contributing to "Regression Testing C-PAC on SLURM Clusters"

Forking this repository

If you're making any changes to secrets or environment variables, please test in a fork of this repository. pre-commit is configured in this repository to update the repository URL in pyproject.toml to match the URL for the local git remote named origin, and a GitHub Actions workflow is configured to match that URL to the target repository when a pull request is opened, reopened, or synced.

flowchart TD

fork[fork repository] --> clone[<code>git clone</code>]
clone --> changes["{make changes in fork}"]
changes --> commit

subgraph commit[<code>git commit</code>]
  subgraph pre-commit
    update_fork[change <code>repository</code> URL in <code>pyproject.toml</code> to <code>git remote origin</code> URL]
  end
end

commit --> push[<code>git push</code>]
push --> PR

subgraph PR[pull request]
  subgraph workflow["'Update Repository URL' workflow"]
    update_PR[change <code>repository</code> URL in <code>pyproject.toml</code> to target repository URL]
  end
end

Loading

To skip the local update, you can run SKIP=local-fork-repo-url git commit where you would normally run git commit.

See Also

Please see the C-PAC Contributing Guide, the FCP-INDI Contributing Guide and Contributor Covenant Code of Conduct for more general contributing guidelines.