Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor/prepyrus v3 #64

Merged
merged 8 commits into from
Aug 14, 2024
Merged

refactor/prepyrus v3 #64

merged 8 commits into from
Aug 14, 2024

Conversation

Firgrep
Copy link
Member

@Firgrep Firgrep commented Aug 14, 2024

  • chore: preparing plan
  • refactor: split out code to new mods
  • refactor: validation mod done, started refactor process to receive structs
  • refactor: split remaining code into utils and inserter files
  • fix: falsely injecting empty bib html
  • feat: add total count for processing
  • chore: print msg
  • chore: tidying prints

PR Author's Note

  • Refactored prepyrus from a single file into multiple files and modules for better readability and maintenance
  • Added some nicer prints and more information upon process completion

Checklist

  • Philosophical or literary contribution (docs). Leave unchecked for code contribution.

    • IMPLIED CONSENT By opening this pull request and contributing philosophical or literary content, I accept that my writing is submitted under the ATTRIBUTION-NONCOMMERCIAL-SHAREALIKE 4.0 INTERNATIONAL, which:

      • Prohibits commercial reuse of the content.
      • Allows sharing, remixing, and building upon the material as long as attribution is given.

      I understand that my writing may be modified, remixed, and built upon by others within the systemphil/sphil or sPhil project, in accordance with the license terms, indefinitely. See legal code.

    • REQUIRED I have followed the formatting guidelines and verified there are no formatting bugs. Try markdown preview here.

    • REQUIRED I have followed the Chicago author-date style.

    • REQUIRED I have added or verified metadata title, description, and contributors at the very top of the file followed by a ## title heading. Additionally, I have ensured isArticle is set to true. Example:

      ---
      title: The Immediate Difference Between Pure Being and Pure Nothing
      description: Learn about the difference between being and nothing in Hegel's Science of Logic.
      isArticle: true
      authors: Jerry Maguire (2024)
      editors: Steve Stevenson (2023), Karen Hansen (2022)
      contributors:
      ---
      
      ## My Article Title
      Further information

      I have signed the document with my name/username under either as Authors, Editors or Contributors.

      Use Authors if you have created and substantially added content.
      Use Editor if you have made substantial edits or review.
      Use Contributor if you have made minor edits, reviews or contributions.
      If you've done multiple, pick the most weighted: Author > Editor > Contributor.
      If you prefer to remain anonymous, that's fine too, but note that a record of your contributions based on your GitHub username will exist here in the codebase.

    • REQUIRED I have ensured that the project's central bibliography contains the necessary bibliographical details for the citations I have used.

    • Optional My article is a stub or I want to actively encourage contribution, I've added the Stub component to the bottom of my content or where relevant:

      import Stub from "@/components/Stub";
      
      <Stub />;
  • If Docs contribution is unchecked: Code contribution (Apache version 2 license)

    All code apart of what is inside src/pages/** (excluding /contributing/**, _app.mdx, _document.tsx, _meta.json, acknowledgements.mdx, index.mdx, privacy.mdx, team.mdx, terms.mdx) is subject to Apache version 2 license. Basically, anything outside of content, literature, philosophy.

@Firgrep Firgrep merged commit b8c80de into main Aug 14, 2024
1 check passed
@Firgrep Firgrep deleted the refactor/prepyrus-v3 branch August 14, 2024 17:53
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.

1 participant