Skip to content

Commit

Permalink
Restructure 07-contributor-guide
Browse files Browse the repository at this point in the history
* Remove general paragraph about the different available branching strategies.
  This paragraph contained a broken link as well.
* Remove broken image for "scaled trunk-based development"
* Moved branch protection rules to branching strategy header and linked to
  where the rules live for FIMS and give a link to GitHub guidance for creating
  rules.
* Removed the header "Outside collaborators and forks"
* Move how to create a good bug report to the Bug Report Issue Form
* Move Issues above branching strategy because developers should know about
  looking for existing issues before creating a branch
* Move much of the information about issues to the actual issues forms
  themselves
* Add more information about labels and how we use categories of labels
* Split cloning and branching into two sections
* Delete guidance to delete feature branches after they are merged because this
  happens automatically
* Move branch naming strategy before branching strategy
* Remove the single sentence under the `Code Development` section that just
  linked to other sections, section was also deleted
* Delete the section on how to prevent merge conflicts because knowledge of
  issues and people using issues as described should eliminate merge conflicts
  that should not be there and merge conflicts are not such a bad thing.
* delete `Cleanup Local Branches` section but move the code to the workflow
  example.
* Delete the table of existing GitHub actions and instead just link to where
  they can be found.
* Change a symbol to an actual apostrophe or remove the contraction.
* Join lines for all paragraphs to be a single line.
* Remove the section on how to request a new GitHub Action because like
  anything else, you just submit an issue.
* Move details from `Details on Backup Checks` to the action itself.
* Change Github to GitHub
* Edit git example calls to start from main, remove initial push to origin of
  feature branch, move all comments in these example calls to text before the
  call
* Adds a header section for git to delineate git from GitHub and put the "git"
  information after the GitHub information.
* Linked to Conventional Commits rather than spelling out guidance.
* Delete the link to feature flags, which is
  https://martinfowler.com/articles/feature-toggles.html because features
  should be tried and tested before being brought in and we want to minimize
  code bloat.
* Removed guideline to lint the code because it is done automatically and was
  not specific to what lintr to use.
* Add distribution folder and a note that it needs to be documented, place an
  underscore between population and dynamics because that is what the folder is
  actually named,
* Move code of conduct message to first paragraph.
* Make subsection of Issues for Projects and a separate section about Teams
  stating that they are not currently used.
* Deleted the list of topics under GitHub Collaborative Environment. Moved the
  relevant information to the specific section.

TODO:
* Find where the review guidance exists online for both sections and reference
  the links
* document makevars and makevars.win
* document distributions folder
* create GitHub action to open an issue in collaborative_workflow when a new
  folder is added to NOAA-FIMS/FIMS/inst/include. Kathryn is going to help but
  I need to find how to know that a new folder was added, i.e., what is the
  reference to compare to?
  • Loading branch information
Kelli.Johnson committed Jul 2, 2024
1 parent 66c49c8 commit 880606d
Showing 1 changed file with 171 additions and 425 deletions.
Loading

0 comments on commit 880606d

Please sign in to comment.