Update CHANGELOG.md#53
Conversation
Added Commit number for new release and revised missing information
hmorzaria
requested review from
andybeet and
jacobkasper
and removed request for
andybeet and
jacobkasper
|
@hmorzaria Since this PR additional content has been pulled into |
|
@hmorzaria Can you please clarify for me what I am reviewing? |
|
@jacobkasper not sure you have been tagged as a reviewer on this PR. But ... the content in In addition, I noticed that some of the entries in the changelog are bulleted, some are not. Thought we might want to bullet all points |
| ### Added | ||
| Created md file with a table listing Atlantis models in use, location, and contact person | ||
| GitHub actions to build and run SETAS when a pull request is triggered | ||
| Templates for bug reporting, feature requests and pull requests that standardize content for maintainers and reviewers. | ||
| Parameter min_pool_cont for the Contaminant module, which sets the threshold for minimum contaminant concentration. This addition decouples min_pool a global parameter from the contaminant submodule. Need to add min_pool_cont as a parameter if using track_contaminants | ||
| Instructions to add new features or bug fixes to the user manual. The documentation should be updated directly after the feature or bug is incorporated in a new release | ||
| Code to identify the Git release and return the release version |
There was a problem hiding this comment.
Should we list the changes with bullets like in the last release?
I see now, I was tagged and then I was removed. I think that is a good idea though to have everything bulleted. |
|
@andybeet I think the easiest at this point is for me to close this pull request and modify the change log again with all the changes in Dev. The problem is that the changes in the Changelog need to be approved promptly if we are going to require a reviewer. Maybe designate a rotating documentation reviewer- it could change monthly? I submitted this PR while in Bergen and assigned it to you @jacobkasper and @somros at different times in the hope that someone would approve it soon. The next release is also stuck because of the Changelog |
|
I dont think you need to close this. But if you want to, i dont have objections The changelog should be merged into We shouldnt be bypassing |
3 participants
Added Commit number for new release and revised missing information
Your commits explain the
who,what,whereandwhenof these changes. Your code shows thehow. You do not need to reiterate this. This PR should complete the big picture by telling thewhy.Justification
Need to keep CHANGELOG updated
If it fixes a bug or resolves a feature request, be sure to link to the issue below.
Types of changes
What types of changes does your code introduce? Put an
xin the boxes that applyDocumentation
Further comments
If this is a New Feature, Breaking change, or a bug fix, the Atlantis Manual will need to be updated to reflect these changes.
Now would be a good time to create an issue in the Atlantis Manual repo and begin documenting your changes.
Reviewer instructions:
Assign at least 2 reviewers:
assigneesfieldPlease detail the process reviewers will need to follow to properly test these changes. It is especially helpful to identify the exact code needed to conduct a local build/review/test and to specify any aspects of the testing that may not be obvious.