Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First housekeeping items to get the project started #2

Merged
merged 28 commits into from
Mar 21, 2022

Conversation

nariman87
Copy link
Contributor

@nariman87 nariman87 commented Mar 18, 2022

Context for changes

  • Minor updates for README.md, documentation, pull_request_template.md, and workflows
  • Fixed a bug in pull_request_template.md:
    The template was not loading properly due to a whitespace bug

Example usage and tests

  • Not Applicable

Performance results justifying changes

  • Not Applicable

Workflow actions

Expected benefits and drawbacks

Expected benefits:

  • Cleaner looking README, documentation, and CI test results.

Related Github issues

  • Not Applicable

Checklist and integration statements

  • My Python and C++ codes follow the coding and commenting styles of this project as indicated by existing files. Specifically, the changes conform to given black, docformatter and pylint configurations.
  • I have performed a self-review of these changes. I have checked my code and corrected misspellings to the best of my capacity. I also confirm that I have already merged other branches into this branch as required.
  • I have added context for corresponding changes in documentation and README.md as needed.
  • I have added new workflow CI tests for corresponding changes and these pass locally for me.
  • I have updated _version.py based on semantic versioning. I recognize that the developers may create a special release including my changes. I recommend a Special Release branch following this PR

@nariman87 nariman87 self-assigned this Mar 18, 2022
@nariman87 nariman87 marked this pull request as draft March 18, 2022 00:52
@nariman87 nariman87 changed the title Housekeeping 220318 First housekeeping items to get the project started Mar 18, 2022
@codecov
Copy link

codecov bot commented Mar 21, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@e961584). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main       #2   +/-   ##
=======================================
  Coverage        ?   90.40%           
=======================================
  Files           ?       30           
  Lines           ?     1813           
  Branches        ?        0           
=======================================
  Hits            ?     1639           
  Misses          ?      174           
  Partials        ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e961584...f7934d8. Read the comment docs.

@nariman87 nariman87 added chores Standard routines for open-source software projects owners review ready CODEOWNERS to review at earliest possible labels Mar 21, 2022
@nariman87 nariman87 marked this pull request as ready for review March 21, 2022 16:30
Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>
@nariman87 nariman87 requested a review from ilan-tz March 21, 2022 16:48
@nariman87 nariman87 merged commit 59063c1 into main Mar 21, 2022
@nariman87 nariman87 deleted the housekeeping-220318 branch March 21, 2022 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chores Standard routines for open-source software projects owners review ready CODEOWNERS to review at earliest possible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants