docs: documenting new naming conventions for commits, branches and PRs.

ansys / pymapdl

Pythonic interface to MAPDL

https://mapdl.docs.pyansys.com

MIT License

419 stars 116 forks source link

docs: documenting new naming conventions for commits, branches and PRs. #3228

Closed germa89 closed 1 day ago

germa89 commented 5 days ago

Description

As the title. I want to have everything clearly stated in the PyMAPDL development section.

Issue linked

Close #3218

Checklist

[ ] I have visited and read Develop PyMAPDL.
[ ] I have tested my changes locally
[ ] I have added necessary documentation or updated existing documentation.
[ ] I have followed the PyMAPDL coding style guidelines.
[ ] I have added appropriate unit tests that also ensure the minimal coverage criteria.
[ ] I have reviewed my changes before submitting this pull request.
[x] I have linked the issue or issues that are solved to the PR if any.
[x] I have assigned this PR to myself.
[x] I have marked this PR as draft if it is not ready to be reviewed yet.
[x] I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

ansys-reviewer-bot[bot] commented 5 days ago

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

wiz-inc-572fc38784[bot] commented 5 days ago

Wiz Scan Summary


IaC Misconfigurations
Vulnerabilities
Sensitive Data
Total
Secrets

germa89 commented 5 days ago

NOT finished.

I need to fix the labels.

codecov[bot] commented 5 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 80.21%. Comparing base (cda716a) to head (68cb8ef).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #3228 +/- ## ========================================== - Coverage 82.64% 80.21% -2.44% ========================================== Files 53 53 Lines 9625 9625 ========================================== - Hits 7955 7721 -234 - Misses 1670 1904 +234 ```

germa89 commented 4 days ago

Ok. Now it is ready.

germa89 commented 1 day ago

many people approved it. Hence @pyansys-ci-bot LGTM.

germa89 commented 1 day ago

I had to disable Require review from Code Owners because @jorgepiloto is not a code owner.

P.D.- @pyansys-ci-bot token has been replaced by a @jorgepiloto's one. Hence for this PR to be merged I had to disable the above requirement, since the workflow now is triggered with @jorgepiloto's credentials which is not a codeowner.

RobPasMue commented 1 day ago

Why not add him to the team temporarily?

germa89 commented 1 day ago

Codeowners require to edit the Codeowners file. I rather change not change files. :)

RobPasMue commented 1 day ago

No, you do not need to change the file - you just need to add @jorgepiloto to the @ansys/pymapdl-maintainers team.

https://github.com/ansys/pymapdl/blob/a0028e6e491a1ca4d7b3c8fdd4405a6a3e8e5249/.github/CODEOWNERS#L8