repository =
branch =
fork =
- Open your web browser and navigate to the issue area of the FOLIO Analytics repository at https://github.com/folio-org/folio-analytics/issues
- Click the New issue button to add an issue for the query you will work on, adding the functional area acronym in the title (e.g., ACQ).
- Use the Milestone drop-down menu on the far right to assign this issue to a particular release (e.g., 1.7 Poppy) if it is a derived table. You do not need to do this for report queries.
- Navigate to https://github.com/folio-org/folio-analytics. Click the Fork button to create a new fork or navigate to your existing fork of the folio-analytics repository and make sure that fork is up-to-date.
-add screenshots (new and existing) - Open your repository (e.g., sbeltaine/folio-analytics), and make sure it is pointing to the master branch on your fork of the repository. If it says “This branch is XX commits behind folio-org:main," click Sync fork to bring your fork up-to-date with folio-org:main.
- The next step is to create an issue for this new query or update to an existing query.
- To create an issue..... - screenshot
- When you edit or create a new report or derived table, you will use the issue number to create a new branch in your GitHub fork of the folio-analytics repository (eg Iss123) so you can tie your branch to the PR and issue. Return to your fork of the folio-analytics repository. Select the Master branch drop-down list. In the branch where it says "Find or create a branch," add "IssXXX," where XXX is the number for the issue you just created. Click the WHAT button to create the branch.
- Create or update the report query or derived table query you wish to contribute to folio-analytics in the appropriate directory on the new IssXXX branch you have created in your own fork of folio-analytics. For instance, if I wanted to update the WHAT table, I would navigate to THIS PLACE in my fork of the repository, open the file, make changes, and click the Commit button to save those changes. -add screenshots
- In your fork for this issue, if you are creating or updating a derived table, you will need to also update runlist.text with the name of the tableso this update is included when you later submit your PR. - Navigate to runlist.text - screenshots
- Go to Pull Requests on your fork for this issue.
- Click the "Compare and Pull Request" button. Submit a pull request (PR) from your fork from that numbered branch. When you go to submit, change the note about the issue number to a description of what your pull request is about, mentioning that it closes issue XXX (e.g., Iss123).
CONTINUE HERE
-A pull request pulls in all commits (all the changes you just made) added to a branch EXPLAIN THIS BETTER
-update Changes by Release section in the folio-analytics wiki with notes about the changes you just made - screenshot
-add the label “needs reviewer” to the PR - screenshot
Example of Comments for Submitting a Pull Request
Closes #757
Updated filename for "po_line_vendor_reference_number" to "po_lines_vendor_reference_numbers" to match equivalent LDP table name.
Also updated entry for "po_line_vendor_reference_number" to "po_lines_vendor_reference_numbers" in runlist.txt file for metadb.
Also updated "--metadb:table po_line_vendor_reference_number" to "--metadb:table po_lines_vendor_reference_numbers" at top of query.
Documented this update on the 1.7 (Poppy) release notes at https://github.com/folio-org/folio-analytics/wiki/Changes-by-Release