Skip to content

Commit 9ce33aa

Browse files
committed
update readme with development workflow
1 parent 6c0636f commit 9ce33aa

1 file changed

Lines changed: 74 additions & 8 deletions

File tree

README.md

Lines changed: 74 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LIM Lab Website
22

3-
This is the official website for the Learning, Inference & Memory (LIM) Lab, led by Dr. Athena Akrami at the Sainsbury Wellcome Centre, UCL, London.
3+
This is the official website for the Learning, Inference & Memory (LIM) Lab, at the Sainsbury Wellcome Centre, UCL, London.
44

55
🌐 **Live at**: [https://lim.bio](https://lim.bio)
66

@@ -166,14 +166,80 @@ The site is live at [https://lim.bio](https://lim.bio) with HTTPS automatically
166166
- **DNS**: 4 A records for redundancy + CNAME for www subdomain
167167
- **GitHub Pages**: Fully compatible with automatic deployment
168168

169-
## 📞 Contact
169+
## 🤝 How to Contribute
170170

171-
For questions about the website or lab, contact:
171+
We welcome contributions to improve the website! Here's how you can help:
172172

173-
- **Email**: <a.akrami@ucl.ac.uk>
174-
- **Institution**: Sainsbury Wellcome Centre, UCL
175-
- **Location**: London, UK
173+
### For Lab Members
176174

177-
---
175+
1. **Update Your Profile**:
176+
- Edit `_data/people.yml` to update your information
177+
- Add or update your photo in `assets/img/`
178+
- Include your latest research interests and publications
178179

179-
*This website showcases the research and people of the LIM Lab, contributing to our understanding of learning, inference, and memory in the brain.*
180+
2. **Add Publications**:
181+
- Edit `_data/publications.yml`
182+
- Follow the existing format for consistency
183+
- Include DOI links when available
184+
185+
3. **Share News**:
186+
- Edit `labnews/index.md`
187+
- Add new items to the "Recent News" section
188+
- Include relevant links and images
189+
190+
### For External Contributors
191+
192+
1. **Report Issues**:
193+
- Found a bug or broken link? Open an issue on GitHub
194+
- Suggest improvements or new features
195+
- Report accessibility or usability problems
196+
197+
2. **Submit Improvements**:
198+
- Fork the repository
199+
- Create a feature branch
200+
- Make your changes
201+
- Submit a pull request with a clear description
202+
203+
### Development Workflow
204+
205+
```bash
206+
# Fork and clone the repository
207+
git clone https://github.com/YOUR-USERNAME/limlabswc.github.io.git
208+
cd limlabswc.github.io
209+
210+
# Install dependencies
211+
bundle install
212+
213+
# Make your changes
214+
# Edit files as needed
215+
216+
# Test locally
217+
bundle exec jekyll serve
218+
219+
# Check at http://localhost:4000
220+
221+
# Commit and push
222+
git add .
223+
git commit -m "Description of changes"
224+
git push origin your-branch
225+
226+
# Create pull request on GitHub
227+
```
228+
229+
### Contribution Guidelines
230+
231+
- **Content**: Keep academic tone and accuracy
232+
- **Images**: Optimize images for web (compress, use appropriate formats)
233+
- **Code**: Follow existing patterns and structure
234+
- **Testing**: Always test changes locally before submitting
235+
- **Documentation**: Update README if you add new features
236+
237+
### Types of Contributions Welcome
238+
239+
- ✅ Content updates (people, publications, news)
240+
- ✅ Bug fixes and broken link repairs
241+
- ✅ Accessibility improvements
242+
- ✅ Performance optimizations
243+
- ✅ Mobile responsiveness fixes
244+
- ✅ SEO improvements
245+
- ✅ New features (with discussion first)

0 commit comments

Comments
 (0)