Skip to content

Conversation

@hichana
Copy link
Contributor

@hichana hichana commented Oct 26, 2021

Closes: N/A

Description

This PR comprises the work by @J00LZ and @hichana on the FLIP fest 'Playground Feature: Markdown READMEs 18'. It adds a 'PROJECT' section that allows the user to create a title, description and readme for the project, with functionality integrated into the export feature (ex. the readme.md file exports with the rest of the code) and various redirects schemes to enhance the user experience.

The API supports the new functionality, with included tests to make sure the new data members are persisted to the API.

We made a comprehensive guide with screenshots to illustrate the features: https://github.com/hichana/flip-fest/blob/submissions/issue-%2318/milestone-%232/TeamExponential/submission/issue-18/milestone-2/TeamExponential/README.md


For contributor use:

  • [x ] Targeted PR against correct branch (see CONTRIBUTING.md)
  • [x ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • x[ ] Code follows the standards mentioned here.
  • [n/a ] Updated relevant documentation
  • [x ] Re-reviewed Files changed in the Github PR explorer
  • [n/a ] Added appropriate labels

Copy link
Contributor

@MaxStalker MaxStalker left a comment

Choose a reason for hiding this comment

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

Thank you for participating in discussion and amendments to the code!

Copy link
Contributor

@janezpodhostnik janezpodhostnik 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, and a really nice addition. I left two minor comments, if you want to address them.

mutation($projectId: UUID!, $title: String!, $description: String!, $readme: String!, $persist: Boolean!) {
updateProject(input: { id: $projectId, title: $title, description: $description, readme: $readme, persist: $persist }) {
id
title
Copy link
Contributor

Choose a reason for hiding this comment

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

There is a tabs vs. spaces issue here. I suggest converting to spaces, to match the lines above and below.


bmStrict := bluemonday.StrictPolicy()

sanitizedTitle := bmStrict.Sanitize(p.Title)
Copy link
Contributor

Choose a reason for hiding this comment

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

If it is not too much trouble I would really like to see a test where the description/title/readme is sanitized.

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.

6 participants