Skip to content

docs: change example to be like GUIDELINES.md#116

Merged
betinacosta merged 1 commit into
mainfrom
docs/padronized-models-name
May 13, 2026
Merged

docs: change example to be like GUIDELINES.md#116
betinacosta merged 1 commit into
mainfrom
docs/padronized-models-name

Conversation

@betinacosta
Copy link
Copy Markdown
Member

Disclaimer: Do not include SAP-internal or customer-specific information in this PR (e.g. internal system URLs, customer names, tenant IDs, or confidential configurations). This is a public repository.

Description

There was a mismatch between GUIDELINES.md where the recommendation was to name models as _models.py but in
CONTRIBUTING.md was only models.py. As we are using _models.py in most of our modules (exept DMS, to fixed later), I changed the CONTIBUTING.md.

Related Issue

Closes #72

(#72)

Type of Change

Please check the relevant option:

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Code refactoring
  • Dependency update

How to Test

Describe how reviewers can test your changes:

  1. Step 1
  2. Step 2
  3. Expected result

Checklist

Before submitting your PR, please review and check the following:

  • I have read the Contributing Guidelines
  • I have verified that my changes solve the issue
  • I have added/updated automated tests to cover my changes
  • All tests pass locally
  • I have verified that my code follows the Code Guidelines
  • I have updated documentation (if applicable)
  • I have added type hints for all public APIs
  • My code does not contain sensitive information (credentials, tokens, etc.)
  • I have followed Conventional Commits for commit messages

Breaking Changes

If this PR introduces breaking changes, please describe:

  • What breaks
  • Migration path for users
  • Alternative approaches considered

Additional Notes

Add any additional context, screenshots, or information that would help reviewers.

@betinacosta betinacosta requested a review from a team as a code owner May 13, 2026 13:04
@betinacosta betinacosta merged commit dad7366 into main May 13, 2026
10 checks passed
@betinacosta betinacosta deleted the docs/padronized-models-name branch May 13, 2026 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

name convention for models.py is inconsistent

2 participants