Contribution Guidelines

​

Welcome Contributors

​

Code of Conduct

• Be respectful and inclusive
• Welcome newcomers and help them learn
• Focus on what is best for the community
• Show empathy towards other community members

​

Getting Help

• Discord: Join the Accord Project Discord Community for real-time support
• GitHub Issues: Search existing issues or create a new one
• Documentation: Check the Accord Project docs

​

How to Contribute

​

Types of Contributions

​

Contribution Workflow

# Fork the repository on GitHub, then clone your fork
git clone https://github.com/<YOUR_USERNAME>/template-playground.git
cd template-playground

# Add upstream remote
git remote add upstream https://github.com/accordproject/template-playground.git

# Create a feature branch
git checkout -b feature/your-feature-name
# or for bug fixes
git checkout -b fix/issue-number-description

git add .
git commit -m "feat: add template export functionality"

# Push to your fork
git push origin feature/your-feature-name

​

Code Standards

​

TypeScript Guidelines

// Good - explicit types
interface Template {
  name: string;
  content: string;
  model: string;
}

function loadTemplate(template: Template): void {
  // ...
}

// Bad - using any
function loadTemplate(template: any) {
  // ...
}

// Good
async function rebuild() {
  const result = await generateTemplate();
  return result;
}

// Avoid
function rebuild() {
  return generateTemplate().then(result => {
    return result;
  });
}

try {
  const result = await rebuild(template, model, data);
  set({ agreementHtml: result, error: undefined });
} catch (error: unknown) {
  set({ 
    error: formatError(error), 
    isProblemPanelVisible: true 
  });
}

​

React Best Practices

// Good
function EditorPanel() {
  const [value, setValue] = useState('');
  return <div>{value}</div>;
}

// Avoid class components unless necessary

function useDebounce<T>(value: T, delay: number): T {
  const [debouncedValue, setDebouncedValue] = useState(value);
  
  useEffect(() => {
    const handler = setTimeout(() => {
      setDebouncedValue(value);
    }, delay);
    
    return () => clearTimeout(handler);
  }, [value, delay]);
  
  return debouncedValue;
}

const MemoizedEditor = React.memo(Editor);

const handleChange = useCallback((value: string) => {
  setTemplateMarkdown(value);
}, [setTemplateMarkdown]);

const processedData = useMemo(() => {
  return complexProcessing(data);
}, [data]);

​

Code Style

• Indentation: 2 spaces
• Semicolons: Required
• Quotes: Single quotes for strings
• Line length: 100 characters (soft limit)
• Naming:
  • camelCase for variables and functions
  • PascalCase for components and types
  • UPPER_CASE for constants

# Check code style
npm run lint

# Many issues can be auto-fixed
npm run lint -- --fix

​

Testing Requirements

​

Test Coverage

• New features: Unit tests + E2E test for main flow
• Bug fixes: Test that reproduces the bug + fix verification
• Refactoring: Ensure existing tests still pass

​

Running Tests Before Submitting

# Run all tests
npm test
npm run test:e2e

# Ensure linting passes
npm run lint

# Check build succeeds
npm run build

​

Pull Request Guidelines

​

PR Title and Description

feat: add PDF export functionality for templates

## Summary
Adds the ability to export generated agreements as PDF files.

## Changes
- Add PDF export button to toolbar
- Integrate html2pdf.js library
- Add export options modal (page size, margins)
- Add unit tests for export logic
- Add E2E test for export workflow

## Related Issues
Closes #145

## Screenshots
[Screenshot of export button and modal]

## Testing
- [ ] Unit tests pass
- [ ] E2E tests pass
- [ ] Manual testing completed
- [ ] Tested in Chrome, Firefox, Safari

​

PR Checklist

• Code follows style guidelines
• Self-review completed
• Comments added for complex logic
• Documentation updated
• Tests added/updated
• All tests pass
• No console errors or warnings
• Build succeeds
• Git history is clean (squash if needed)

​

Review Process

​

What to Expect

1. Initial Review: A maintainer will review within 1-3 business days
2. Feedback: You may receive requests for changes
3. Iteration: Address feedback and update the PR
4. Approval: Once approved, a maintainer will merge

​

Review Criteria

• Code quality and style adherence
• Test coverage and quality
• Documentation completeness
• Performance implications
• Security considerations
• Backward compatibility

​

Special Contribution Areas

​

Adding New Template Samples

1. Create a new file in src/samples/ (e.g., mytemplate.ts)
2. Export NAME, TEMPLATE, MODEL, and DATA:

export const NAME = "My Template";

export const TEMPLATE = `
Your TemplateMark content here
`;

export const MODEL = `
namespace org.example

concept MyData {
  o String field
}
`;

export const DATA = {
  "$class": "org.example.MyData",
  "field": "value"
};

3. Add to src/samples/index.ts:

import * as mytemplate from './mytemplate';

export const SAMPLES = [
  // ... existing samples
  mytemplate,
];

​

Adding Learning Pathway Steps

​

AI Assistant Improvements

• Support multiple LLM providers
• Include proper error handling
• Respect rate limits
• Protect API keys

​

License

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 */

​

Recognition

• GitHub contributors list
• Release notes for significant contributions
• Project README (for major features)

​

Questions?

• Discord: Accord Project Community
• GitHub: Comment on issues or discussions
• Email: Reach out to the Accord Project team

​

Next Steps