Skip to content

Conversation

hajdik
Copy link
Contributor

@hajdik hajdik commented Sep 2, 2022

Purpose

We have a contribution guide for pyOptSparse but most of the info is generally applicable to the lab's codes so it can be centralized. After this is made, other repos can link to it from their docs and include additional info specific to the individual repos on their own contribution page.

Expected time until merged

Soon, not a major change

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

N/A

Checklist

  • I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@hajdik hajdik requested a review from a team as a code owner September 2, 2022 16:06
@hajdik hajdik requested review from yqliaohk and sseraj September 2, 2022 16:06
@hajdik hajdik requested a review from sseraj September 9, 2022 17:15
Copy link
Collaborator

@sseraj sseraj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few more comments

Copy link
Collaborator

@sseraj sseraj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@yqliaohk yqliaohk merged commit a6e689a into main Sep 26, 2022
@marcomangano marcomangano deleted the contribute branch September 26, 2022 14:52
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.

3 participants