Contribute - NeuroSites

Ready to contribute?

Start by forking our repository and reading our detailed contributing guidelines. Your templates help make neuroscience research more accessible!

Fork Repository

Template Requirements

To ensure quality and consistency, all template submissions must meet these requirements:

Technical Requirements

Clean HTML/CSS, responsive design, cross-browser compatibility, optimized performance, and accessibility best practices.

Content Requirements

Relevant to neuroscience communities, professional quality design, generic placeholder content, no personal information.

Documentation Requirements

Clear README.md, preview image, manifest.json metadata, and CC BY 4.0 compatible license.

Technical Standards

Clean HTML/CSS: Well-structured, semantic HTML with organized CSS
Responsive Design: Works well on desktop, tablet, and mobile devices
Cross-browser Compatibility: Functions properly in modern browsers
Performance: Optimized images and efficient code
Accessibility: Follows basic accessibility best practices

Quality Tip

Test your template on multiple devices and browsers before submission. Tools like BrowserStack or simple device testing can help ensure compatibility.

Submission Process

Prepare Template

Create, test thoroughly, remove personal info, and write clear documentation for your template.

Fork & Clone

Fork the NeuroSites repository, clone to your machine, and create a new branch.

Add Template

Navigate to category folder, create new template folder, add files and documentation.

Submit PR

Commit changes, push to fork, submit pull request with detailed description.

Important Note

Make sure to test your template on a clean environment to ensure all dependencies are included and paths are correct.

Template Categories

We organize templates into these main categories. Choose the most appropriate one for your submission:

Lab Websites

Research group homepages, project sites, lab portfolios

Personal Pages

Academic portfolios, researcher profiles, CV sites

Event Promotions

Conference sites, workshop pages, symposium sites

Package Wikis

Software documentation, package sites, tool guides

New Category?

If your template doesn't fit these categories, suggest a new one in your pull request! We're always open to expanding our collection.

Manifest File Format

Include a manifest.json file with your template containing the following metadata:

Example manifest.json

{
  "title": "Your Template Name",
  "description": "Brief description of the template",
  "category": "Lab Websites",
  "tags": ["modern", "research", "responsive"],
  "style": "Modern",
  "theme": "Blue",
  "author": "Your Name",
  "license": "CC BY 4.0",
  "version": "1.0.0"
}

Review Process

Once you submit a pull request, our team follows a thorough review process:

Initial Review

Check that all requirements are met and documentation is complete.

Technical Review

Test functionality, responsiveness, and cross-browser compatibility.

Quality Review

Assess design quality, code organization, and user experience.

Feedback & Approval

Provide improvement suggestions or approve for merge into main repository.

Review Timeline

Most reviews are completed within 5-7 business days. Complex templates or those requiring changes may take longer.

Recognition & Rewards

We believe in recognizing our amazing contributors! Here's how we say thank you:

Template Credit

Your name featured in the template's metadata and README file for all users to see.

Contributors List

Added to our official contributors list and project acknowledgments.

Release Notes

Acknowledged in release notes when your template is published to the community.

Maintainer Invitation

Regular contributors are invited to join our maintainer team with additional privileges.

Questions & Support

Need help with your contribution? We're here to support you every step of the way:

Contributing Guide

Detailed contributing guidelines with step-by-step instructions.

Community Discussions

Browse existing discussions or start a new conversation.

Issue Support

Found a bug or need help? Submit an issue and we'll help you out.

Thank You!

We're incredibly excited to see what you'll create! Your contributions help make NeuroSites a valuable resource for the entire neuroscience community. Every template, bug fix, and suggestion makes a difference.