update contribution guide

components/contents.js

@@ -3,17 +3,10 @@ export const contents = {
     Conduct: '/tech/conduct',
     GitHub: '/tech/github',
   },
-  'Data Science': {
-    Overview: '/tech/data-science',
-    Contributing: '/tech/data-science/contributing',
-    Environments: '/tech/data-science/environments',
-    Style: '/tech/data-science/style',
-    Testing: '/tech/data-science/testing',
-  },
-  'Front-end': {
-    Overview: '/tech/front-end',
-    Articles: '/tech/front-end/articles',
-    Contributing: '/tech/front-end/contributing',
-    Deployment: '/tech/front-end/deployment',
+  'Contributing Guide': {
+    Intro: '/tech/contributing',
+    Environments: '/tech/environments',
+    Style: '/tech/style',
+    Testing: '/tech/testing',
   },
 }

pages/index.js

@@ -1,6 +1,7 @@
-import { Layout, Row, Column } from '@carbonplan/components'
-import Heading from '../components/heading'
+import { Column, Layout, Link, Row } from '@carbonplan/components'
+import { Box, Text } from 'theme-ui'
 import Card from '../components/card'
+import Heading from '../components/heading'
 
 const Index = () => {
   return (
@@ -12,7 +13,18 @@ const Index = () => {
       >
         Docs
       </Heading>
-      <Row sx={{ mt: [6, 7, 8, 9] }}>
+      <Row sx={{ mt: [4, 5, 6, 7] }}>
+        <Column start={[1, 2, 3, 3]} width={[6, 8, 9, 9]}>
+          <Box variant='text.mono'>
+            <Text>
+              You can also check out our{' '}
+              <Link href={'tech/'}> contributor guide </Link>
+              on how to contribute to our projects.
+            </Text>
+          </Box>
+        </Column>
+      </Row>
+      <Row sx={{ mt: [4, 5, 6, 7] }}>
         <Column start={[1, 2, 3, 3]} width={[6, 8, 9, 9]}>
           <Row columns={[2, 3, 3, 3]}>
             <Card

pages/tech/conduct.md

@@ -62,7 +62,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected].
+[[email protected]](mailto:[email protected]).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

pages/tech/contributing.md

@@ -0,0 +1,87 @@
+import Section from '../../components/section'
+
+# Contribution Guide
+
+This page serves as a general contribution guide for CarbonPlan data science projects. Some projects within the organization may also provide customized contribution guides.
+
+## Getting Started
+
+If you're new to contributing to CarbonPlan projects, here are some resources to help you get started:
+
+- Familiarize yourself with our [GitHub organization](https://github.com/carbonplan)
+- Read our [Code of Conduct](./conduct)
+- Check out our [style guide](./style) to understand our coding standards
+
+## Reporting Issues
+
+We use GitHub Issues to track bugs and feature requests. When submitting an issue:
+
+- Use clear, descriptive titles
+- Provide detailed steps to reproduce bugs
+- For feature requests, explain why the feature would be useful
+- Include relevant information about your environment
+
+## Development Workflow
+
+### Setting Up Your Environment
+
+1. Fork the repository on GitHub
+2. Clone your fork locally
+3. Set up the development environment (project-specific instructions will be in each repository's README)
+
+### Branch Strategy
+
+- Work on a feature branch named appropriately (e.g., `feature/add-new-filter` or `fix/resolve-data-loading-issue`)
+- Keep your branch focused on a single issue or feature
+- Reference our [GitHub workflow](./github) for more details on branches and pull requests
+
+### Code Contributions
+
+When contributing code:
+
+- Follow our [style guide](./style) for code formatting
+- Write [tests](./testing) for new functionality
+- Update documentation to reflect your changes
+- Use [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) style for Python docstrings
+
+### Documentation Contributions
+
+Good documentation is as important as good code:
+
+- Keep language clear and concise
+- Update examples to reflect code changes
+- Ensure documentation builds without errors
+- Preview changes locally before submitting
+
+### Submitting Changes
+
+1. Commit your changes with descriptive messages
+2. Push to your fork
+3. Submit a pull request from your branch to the main repository
+4. Address feedback during code review
+
+## Code Review Process
+
+All submissions go through a review process:
+
+- A maintainer will review your PR
+- Automated tests must pass
+- Changes may be requested before merging
+- Be responsive to questions and feedback
+
+## Project Versioning
+
+The choice of versioning scheme depends on the project and its goals. We use two versioning schemes depending on the project type:
+
+- [Calendar Versioning (CalVer)](https://calver.org/)
+  - The format is `YYYY.MM.DD` or `YYYY.MM.DD.N`
+  - Used for: projects with frequent updates (e.g., [offsets-db-data](https://github.com/carbonplan/offsets-db-data))
+  - When: release schedule is time-based rather than feature-based
+- [Semantic Versioning (SemVer)](https://semver.org/)
+  - The format is `MAJOR.MINOR.PATCH` (e.g., `1.2.3`)
+  - Used for: projects with a more stable release cycle (e.g., [cmip6-downscaling](https://github.com/carbonplan/cmip6-downscaling))
+  - When: breaking changes need to be communicated clearly and new features are added in a backwards-compatible manner.
+
+export default ({ children }) => (
+
+<Section name='contributing'>{children}</Section>)