Merge pull request #39 from sbryngelson/improve

Author: sbryngelson

.github/PULL_REQUEST_TEMPLATE/default.md

@@ -0,0 +1,7 @@
+## Description
+
+<!-- Provide a brief description of the changes you're making -->
+
+## Related Issue(s)
+
+<!-- Link to any related issues (e.g., "Closes #123") -->

.github/workflows/linkchecker.yml

@@ -1,6 +1,8 @@
 name: LinkChecker
-
-on: push
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   markdown-link-check:

.github/workflows/spelling.yml

@@ -1,6 +1,7 @@
 name: Spell Check
 on:
   push:
+  pull_request:
   workflow_dispatch:
 
 jobs:

CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to the Group Syllabus
+
+Thank you for considering contributing to our research group syllabus!
+This document provides guidelines for students and collaborators who want to suggest improvements, fix errors, or add new content.
+
+## Why Contribute?
+
+- **Improve the resource for everyone**: Your experiences and insights can help make this a better resource for current and future students.
+- **Develop your skills**: Contributing to documentation is valuable practice for academic and professional work.
+- **Build community**: Collaborative maintenance strengthens our research group.
+
+## How to Contribute
+
+### For Small Changes (Typos, Minor Clarifications)
+
+1. **Create an Issue**: 
+   - Go to the [Issues tab](https://github.com/comp-physics/group-docs/issues) and create a new issue
+   - Use a clear title and describe the change you're suggesting
+   - Label it appropriately (e.g., "typo", "clarification")
+
+2. **Direct Pull Request**:
+   - For simple changes, you can directly edit the file on GitHub
+   - Click the pencil icon on the file you want to edit
+   - Make your changes and create a pull request with a clear description
+
+### For Larger Contributions (New Content, Major Revisions)
+
+1. **Discuss First**:
+   - Create an issue describing what you'd like to add or change
+   - Wait for feedback before investing significant time
+
+2. **Fork and Clone**:
+   - Fork the repository to your GitHub account
+   - Clone it to your local machine
+   - Create a new branch for your changes
+
+3. **Make Changes**:
+   - Make your changes or additions
+   - Follow the existing style and formatting
+   - Add clear commit messages
+
+4. **Submit a Pull Request**:
+   - Push your changes to your fork
+   - Create a pull request to the main repository
+   - Provide a clear description of the changes and why they're valuable
+
+## Content Guidelines
+
+When contributing content, please follow these guidelines:
+
+1. **Be Clear and Concise**: Write in clear, straightforward language.
+2. **Be Accurate**: Verify information before submitting.
+3. **Follow Existing Structure**: Match the style and organization of existing documents.
+4. **Consider All Students**: Remember that this resource serves both PhD and undergraduate students.
+5. **Respect Confidentiality**: Don't include sensitive or private information.
+
+## Document Structure
+
+When creating or editing markdown files:
+
+- Use appropriate heading levels (# for title, ## for major sections, ### for subsections)
+- Include a table of contents for longer documents
+- Use bullet points and numbered lists for clarity
+- Link to other relevant documents when appropriate
+
+## Review Process
+
+After submitting a contribution:
+
+1. Spencer will review your submission
+2. You may receive feedback or requests for changes
+3. Once approved, your contribution will be merged
+
+## Getting Help
+
+If you're unsure about anything related to contributing:
+
+- Contact Spencer directly
+- Post a question in the group Slack channel
+
+## Recognition
+
+Contributors will be acknowledged in the repository. 
+
+Thank you for helping improve our group documentation! 

readme.md

@@ -34,6 +34,13 @@
 * [For figures](templates/paper/figures)
 * [For talks](templates/talks)
 
+## Contributing
+
+This repository is designed to be collaborative.
+Current and former students are encouraged to contribute improvements, corrections, and additions based on their experiences.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to suggest changes or add content.
+
 ## Acknowledgements
 
 Parts of this are borrowed, heavily edited, from the Ph.D. syllabi of [Eric Gilbert](https://docs.google.com/document/d/11D3kHElzS2HQxTwPqcaTnU5HCJ8WGE5brTXI4KLf4dM) and Mor Maaman.