Skip to content

Commit 40787c5

Browse files
committed
add: info on contributing
1 parent 2e941fc commit 40787c5

File tree

1 file changed

+53
-4
lines changed

1 file changed

+53
-4
lines changed

README.md

Lines changed: 53 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,57 @@ Edit `data/research.json` to add or modify research directions.
9696

9797
## Contributing
9898

99-
This is a research lab website. For updates or corrections:
99+
We welcome contributions to improve the website! All changes should go through the pull request process to ensure quality and allow for review.
100100

101-
1. Create a feature branch
102-
2. Make your changes
103-
3. Submit a pull request
101+
### Workflow
102+
103+
1. **Fork and clone** the repository (external contributors) or create a branch (team members)
104+
105+
```bash
106+
git checkout -b feature/your-feature-name
107+
```
108+
109+
2. **Make your changes** following our development best practices
110+
- Run `npm run dev` to preview changes locally
111+
- Test responsiveness on different screen sizes
112+
- Ensure accessibility standards are met
113+
114+
3. **Test thoroughly** before committing
115+
116+
```bash
117+
npm run lint # Check code quality
118+
npm test # Run test suite
119+
npm run build # Verify production build works
120+
```
121+
122+
4. **Commit your changes** with clear, descriptive messages
123+
124+
```bash
125+
git add .
126+
git commit -m "feat: add new team member profile"
127+
```
128+
129+
5. **Push to your branch** and create a pull request
130+
131+
```bash
132+
git push origin feature/your-feature-name
133+
```
134+
135+
6. **Open a Pull Request** on GitHub
136+
- Provide a clear title and description
137+
- Explain what changes were made
138+
- Request review from team members
139+
140+
7. **Merge** once approved
141+
- Squash commits if there are many small changes
142+
- Delete the feature branch after merging
143+
144+
### Quick Content Updates
145+
146+
For simple content updates (team members, publications, research areas):
147+
148+
1. **Always start with a pull request** - even for small changes
149+
2. Edit the relevant JSON file in `/data/`
150+
3. Follow the existing data structure and formatting
151+
4. Verify the change appears correctly in development mode
152+
5. Submit PR with clear description of what was added/changed

0 commit comments

Comments
 (0)