This guide is designed to help you navigate your weekly reporting, which is essential for tracking project progress, identifying areas where you need support, and maintaining clear communication with the team.
Below, you will find the steps to create and update your report, templates to refer to, and a legend to guide you.
- Create one file in the repository (BIDS / interns) named
[last name]-[first initial].md - This single file will serve as your log for the entire duration of your internship.
- Create a Branch: Do not edit the
mainbranch directly. Each week, create a new branch namedreport-[your-name]-[date]. - Edit your file: Add your new entry to the top of your
weekly-report-[your-name].mdfile. - Commit & Push: Save your changes with a clear message (e.g., "Add weekly report for XX Aug 11").
- Open a Pull Request (PR): Open a new PR to merge your branch into
main. - Merge: Once your supervisor has seen the report and left any necessary comments, the PR will be merged, and the process starts over the following week.
Please read the example below for guidance on detail, then refer to the Clean Template into your personal report file to begin your weekly entry.
- [Things that went well this week. | This week was the last time all the interns were here together, and it was just nice having everyone around, even though I was sometimes too busy to be there all day.]
- [Something with potential or your're looking forward to. | I'm looking forward to the hackathon next week, especially with the added context KW shared that makes it feel a lot more developmental.]
- [A challenge or pain point that needs attention. | Reimbursement processes proved to be complicated (of course). ]
- [Summary with names in initials | Getting the process started for travel reimbursements for upcoming speaker.]
- [Names in initiials | LWH & TH]
- [Tasks | reviewed BCEN blog post draft.]
- [Task description (X hrs) | Coordinated with future lecture speaker (1 hr).]
- [Task description (X hrs) | Coordinated CRELS and CSSTP schedule (3 hrs).]
- My available hours next week are:
- [Your assigned timeslots (Full or changes if needed) |
- Mon, 11am to 2pm (Full)
- Wed, 1pm to 4pm (Need to leave at 3pm for an event)
- Fri, 10am to 3pm (Unavailable due to a midterm)]
- [Tasks | Continue blog for Developer Summit.]
- [Things that went well this week.]
- [Something with potential or your're looking forward to.]
- [A challenge or pain point that needs attention.]
- [Summary with names in initials.]
- [Names in initiials]
- [Tasks.]
- [Task description (X hrs)]
- [Task description (X hrs)]
- My available hours next week are:
- [Your timeslots (Full or changes if needed)]
- [Tasks.]
This is the legend of the templates for the weekly reports that the BIDS interns will be working on. The weekly reports are to be completed every week, keeping the latest report on the top, with older reports below in chronological order.
- Leave one blank line after each section to keep the report easy to read on GitHub.
- Make sure to start another numbered line after each complete sentence, to make it easy to keep track of the lines.
- Period after every complete sentence.
- Names in Initials
- Put the latest report at the top so we can scroll down to the oldest reports, starting from the first week.
- For the subtitles, use hashtags + space + subtitle.
- "# A first-level heading"
- "## A second-level heading"
- "### A third-level heading"
- Styling
- Bold: This is bold text (or Command+B (Mac) or Ctrl+B (Windows/Linux))
- Italic: This text is italicized (or Command+i or Ctrl+i)
- All Bold and Italic: All this text is important
- Subscript: This is a subscript text.
- Underline: This is an underlined text.
- Quoting
- Quoting text: use >
-
Text that is a quote.
-
- Quoting code in a sentence: use single backticks
- Quoting an entire block of codes or commands: use triple backticks
- Quoting text: use >
- Links
- Link text in brackets [ ], and the URL in parenthesis ()
- Please fill out the application form
- Link text in brackets [ ], and the URL in parenthesis ()
- Image
- use 
- use 
- Lists
- Bullet Points: add a space after * or - or + and then start your sentence.
- Ordered list: use numbers 1. 2. 3. etc.
- Nested Lists: start a new line with two more spaces and use - or *
- To-do lists: Preface list items with a hyphen - and space followed by [ ]. To mark a task as complete, use [x]
-
- Done
- Haven't finished yet
-
- Emoji: use a colon : and the name of your emoji, typing the colon and a letter will pull up a list of recommended emojis.
- Footnotes: 1 after the content, and then start a new line, add your notes after 1:
- This is a chocolate 1.
- Alerts:use a special blockquote line specifying the alert type, followed by the alert information in a standard blockquote.
-
[!NOTE] Useful information that users should know, even when skimming content. [!TIP] Helpful advice for doing things better or more easily.
- and there are also [!IMPORTANT] [!WARNING] [!CAUTION]
-
- Ignoring the github markdown formattings: use a backlash \ before the markdown character.
- This syntax legend is adapted from (https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#ignoring-markdown-formatting); credit to the original source 👍.
