Feature/switch to GitHub flow

[camUrban]

Description

This pull request focuses on improving project documentation and contribution guidelines, especially for new contributors. The main updates include a comprehensive rewrite of CONTRIBUTING.md, enhancements to the pull request template, and updates to the README.md to reflect the current branching strategy and correct references.

Motivation

These changes aim to clarify the contribution process, encourage best practices, and ensure documentation is accurate and up to date. See #36 for more details on the factors motivating the switch from GitFlow to GitHub Flow.

Relevant Issues

This PR closes #36.

Changes

• Major rewrite and reorganization of CONTRIBUTING.md:
  • Expanded sections on reporting bugs, requesting enhancements, and contributing code.
  • Added step-by-step instructions for setting up a development environment, branching, and submitting pull requests using GitHub Flow.
  • Clarified code style requirements and documentation standards.
• Updated README.md:
  • Changed all references from master/release-3.1.0 to main to match the new default branch.
  • Updated badges, image links, and instructions for installing dependencies and using the package.
  • Added acknowledgments for new contributors and tools, and clarified the use of GitHub Flow for development.
• Added a new word (helbling) to the spell-check dictionary to prevent false positives in code reviews.
• Improved .github/pull_request_template.md:
  • Refined prompts for PR descriptions, motivation, and issue linking.
  • Updated checklist to enforce code style, documentation, and testing standards.
  • Clarified change magnitude options.

New Dependencies

None

Change Magnitude

Minor

Checklist

• You've created an issue detailing these changes.
• All calculations use S.I. units.
• You've formatted your code using black.
• You've used a line-length of 88.
• All modules, scripts, classes, methods, and functions you've written have
  docstrings.
• Your docstrings use the reStructuredText format.
• Your code is well documented using block comments.
• If you've made any major changes, you've also created new tests in the tests
  package.
• If you use any code or equations from someone else, you've cited your sources in
  a comment or docstring.

[Copilot]

Pull Request Overview

This PR improves project documentation and contribution guidelines for new contributors by switching from GitFlow to GitHub Flow branching strategy. The changes simplify the development process and ensure documentation accurately reflects the current project structure.

• Updates branching strategy from GitFlow to GitHub Flow throughout documentation
• Replaces all repository references from master/release-3.1.0 to main branch
• Enhances contribution guidelines with detailed step-by-step instructions for new contributors

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File	Description
README.md	Updates badges, image links, and code examples to use main branch; adds acknowledgments and clarifies GitHub Flow usage
CONTRIBUTING.md	Major rewrite with expanded sections on bug reporting, enhancement requests, and detailed GitHub Flow contribution process
.github/pull_request_template.md	Refines PR template with clearer prompts, updated checklist items, and improved change magnitude descriptions

Files not reviewed (1)

• .idea/dictionaries/project.xml: Language not supported

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

[nitpick] The line break appears to be in an awkward position, splitting the sentence 'I am also using the [GitHub Flow]' across lines. Consider keeping 'I am also using the GitHub Flow' on a single line for better readability.