Skip to content

Conversation

@zhan4329
Copy link
Contributor

@zhan4329 zhan4329 commented Nov 13, 2025

Description

This Pull Request reformulates student contributions of conda guides into environment.yml from PR #56 and PR #54. In addition, it edits several documentation files to display 25-26 Data Mine Team information and improve contributing environment.

Related Issue/PR

Reformulates #54 and #56

Changes

  • Adds a short CONTRIBUTING.md with links to SCSAWorkflow's contributing guide and the copilot instructions in the current repo for reference.
  • Updates README.md in Documentation & Support section with a link to the newly added CONTRIBUTING.md.
  • Updates TECHNICAL_DETAILS.md with names of this year's Data Mine Shiny Team members and TA.
  • Updates environment.yml:
    • Adds a warning that this file may be outdated
    • Updates package versions accordingly with the latest requirement.txt
    • Adds a quick start guide for conda users (high school PR)
    • Adds a special reminder for mac arm64 users to apply additional editions before creating conda environment (high school PR)

zhan4329 and others added 17 commits November 6, 2025 16:56
…AP#61

small fixes
- Update environment.yml to make it consistent with requirement.txt
- Update README.md to include TA's name

docs clean-up
- Update .gitignore to include Jupyter section
- Write clearer comments in Dockerfile; remove redundant comments
README:
- Add a "Getting Started" section with a link to the getting_started.md
- Add a "Contributing" section with a link to the CONTRIBUTING.md
- Adjust the format of Project Team Members list and add year

CONTRIBUTING:
- Adjust the link to markdown format
@zhan4329 zhan4329 marked this pull request as ready for review November 13, 2025 18:38
@zhan4329 zhan4329 changed the title Documentation Update Reformulation of Student Contribution on Documentation with Additional Updates from 25-26 Data Mine Team Nov 15, 2025
@zhan4329 zhan4329 changed the title Reformulation of Student Contribution on Documentation with Additional Updates from 25-26 Data Mine Team Reformulation of Student Contributions on Documentation with Additional Updates from 25-26 Data Mine Team Nov 15, 2025
@zhan4329 zhan4329 marked this pull request as draft November 15, 2025 02:59
@zhan4329 zhan4329 changed the title Reformulation of Student Contributions on Documentation with Additional Updates from 25-26 Data Mine Team Reformulation of Student Contributions on Documentation with Additional Updates for 25-26 Data Mine Team Nov 15, 2025
@zhan4329 zhan4329 marked this pull request as ready for review November 15, 2025 03:01
@georgezakinih georgezakinih merged commit bc5679c into FNLCR-DMAP:main Nov 20, 2025
@zhan4329 zhan4329 linked an issue Nov 20, 2025 that may be closed by this pull request
10 tasks
@zhan4329 zhan4329 deleted the docs/readme-guide-11 branch November 20, 2025 18:24
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.

Documentation - Update README and guides and more

7 participants