Skip to content

Latest commit

 

History

History
102 lines (67 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

102 lines (67 loc) · 3.52 KB

Contributing to CivicTech Toronto

Thank you for your interest in contributing to CivicTech Toronto's website! We welcome contributions from the community.

All contributors are expected to follow our Code of Conduct.

Ways to Contribute

Archive Content Contributions

The archives/ directory contains historical data about CivicTech Toronto events, people, projects, organizations, and resources. This content is primarily maintained by the community archivist, but we welcome contributions for:

  • Resource recommendations
  • Community project additions or updates
  • Speaker profile corrections or enhancements
  • Historical event information corrections

How to contribute archive content:

  1. Submit an issue describing the correction, addition, or update you'd like to make
  2. Submit a pull request with your proposed changes (see archives/README.md for details on the archive structure)
  3. Join the conversation on Slack in the #org-archives channel

For detailed information about the archive, see archives/README.md.

Website & Code Contributions

Contributions to improve the website pages, functionality, design, or developer experience are welcome!

Getting Started

  1. Fork the repository and clone it locally
  2. Follow the setup instructions in the README.md to get your development environment running
  3. Create a new branch for your changes: 
    git checkout -b your-feature-name

Making Changes

  • Website pages are located in _pages/
  • Test your changes locally by running bundle exec jekyll serve
  • Preview at localhost:4000 before submitting

Submitting a Pull Request

  1. Test locally - Make sure the site builds and displays correctly
  2. Write a clear description - Explain what your changes do and why
  3. Link to related issues - If your PR addresses an issue, reference it
  4. Be responsive - Be prepared to discuss and iterate on your changes

Example PR description:

## Summary
Brief description of what this PR does

## Changes
- List of specific changes made

## Testing
How you tested these changes locally

Fixes #123

Questions or Need Help?

  • GitHub Issues - For bug reports, feature requests, or questions about contributing
  • Slack - Join the conversation on CivicTech Toronto Slack
    • #org-archives for archive-related discussions
    • General channels for website and community questions

Development Notes

Updating the Archives Submodule

If you're working with archive content:

git submodule update --remote --merge

Generating Category and Tag Data

After making changes to archive content, you may need to regenerate category and tag data:

./_scripts/generate_category_data.sh
./_scripts/generate_tag_data.sh
./_scripts/generate_category_pages.sh
./_scripts/generate_tag_pages.sh

License

This project uses a dual-license structure:

  • Code contributions (Jekyll templates, scripts, stylesheets, etc.) are licensed under the MIT License
  • Content contributions (website pages, documentation, archive content) are licensed under CC BY-NC-SA 4.0

By contributing to this project, you agree that your contributions will be licensed under the appropriate license based on the type of contribution. See LICENSE for full details.