Skip to content

Commit 1488028

Browse files
committed
Release v1.2.0: Enhanced discoverability and user experience
Major improvements: - Strategic emoji integration throughout documentation for better scannability - "At a Glance" comparison table showing benefits vs traditional CoCs - Enhanced README structure with visual organization and table of contents - Comprehensive quality tools: markdownlint, pre-commit hooks, EditorConfig - Visual adoption flow diagram with Mermaid flowchart - Improved package.json metadata with better keywords for discoverability - Versioning system for policy document with changelog integration - Enhanced pull request template with quality assurance checklists Technical improvements: - Line endings standardized to LF with .gitattributes - Pre-commit configuration with markdown table formatter and validation - GitHub Actions workflow with separate linting and verification jobs - Consistent formatting rules via EditorConfig for cross-editor compatibility The policy maintains its focus on reduced distraction environments while becoming more discoverable and easier to adopt.
1 parent b24ca4b commit 1488028

29 files changed

+2033
-69
lines changed

.editorconfig

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# All files
7+
[*]
8+
charset = utf-8
9+
end_of_line = lf
10+
insert_final_newline = true
11+
trim_trailing_whitespace = true
12+
indent_style = space
13+
indent_size = 2
14+
15+
# Markdown files
16+
[*.md]
17+
max_line_length = 120
18+
trim_trailing_whitespace = true
19+
20+
# YAML files
21+
[*.{yml,yaml}]
22+
indent_size = 2
23+
24+
# JSON files
25+
[*.json]
26+
indent_size = 2
27+
28+
# Package.json
29+
[package.json]
30+
indent_size = 2

.gitattributes

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Set default behavior to automatically normalize line endings
2+
* text=auto
3+
4+
# Ensure all text files use LF line endings
5+
*.md text eol=lf
6+
*.json text eol=lf
7+
*.yml text eol=lf
8+
*.yaml text eol=lf
9+
*.js text eol=lf
10+
*.ts text eol=lf
11+
*.py text eol=lf
12+
*.sh text eol=lf
13+
14+
# Images should be treated as binary
15+
*.png binary
16+
*.jpg binary
17+
*.jpeg binary
18+
*.gif binary
19+
*.webp binary
20+
21+
# Archives
22+
*.zip binary
23+
*.tar.gz binary

.github/ISSUE_TEMPLATE/adoption_guide.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,38 @@ assignees: ''
77
---
88

99
## Project Context
10+
1011
Describe your project and community:
12+
1113
- Project type: [e.g., open source library, research project, internal tool]
1214
- Community size: [e.g., 5-10 contributors, 100+ contributors]
1315
- Current governance: [e.g., none, informal, existing CoC]
1416
- Main challenges: [e.g., off-topic issues, heated debates, unclear boundaries]
1517

1618
## Adoption Goals
19+
1720
What do you hope to achieve with the Bounded Contribution Policy?
21+
1822
- [ ] Reduce off-topic discussions
1923
- [ ] Clarify contribution standards
2024
- [ ] Maintain technical focus
2125
- [ ] Establish clear boundaries
2226
- [ ] Other: [specify]
2327

2428
## Specific Questions
29+
2530
List any specific questions about implementing the policy:
26-
1.
27-
2.
28-
3.
31+
1.
32+
2.
33+
3.
2934

3035
## Customization Needs
36+
3137
Are there aspects of the policy that need adaptation for your context?
3238

3339
## Timeline
40+
3441
When are you planning to implement this policy?
3542

3643
---
37-
**Note:** The Bounded Contribution Policy is designed to be adapted for different contexts. We'll help you find the right approach for your project.
44+
**Note:** The Bounded Contribution Policy is designed to be adapted for different contexts. We'll help you find the right approach for your project.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,35 @@ assignees: ''
77
---
88

99
## Issue Description
10+
1011
Clear description of the implementation problem or template issue.
1112

1213
## Steps to Reproduce / Context
14+
1315
1. Which template or policy section
1416
2. How it was implemented
1517
3. What went wrong
1618

1719
## Expected Outcome
20+
1821
What should happen when implementing this policy/template.
1922

2023
## Actual Outcome
24+
2125
What actually happens in practice.
2226

2327
## Implementation Context
28+
2429
- Project type: [e.g., open source library, internal tool]
2530
- Platform: [e.g., GitHub, GitLab, Bitbucket]
2631
- Team size: [e.g., solo, small team, large community]
2732
- Specific template/section: [which part of the policy]
2833

2934
## Additional Information
35+
3036
- Community feedback received
3137
- Workarounds attempted
3238
- Suggestions for improvement
3339

3440
---
35-
**Note:** Please focus on technical details and reproduction steps. See our [Bounded Contribution Policy](../../CODE_OF_CONDUCT.md) for contribution guidelines.
41+
**Note:** Please focus on technical details and reproduction steps. See our [Bounded Contribution Policy](../../CODE_OF_CONDUCT.md) for contribution guidelines.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,32 @@ assignees: ''
77
---
88

99
## Enhancement Objective
10+
1011
Describe the specific policy gap or improvement opportunity.
1112

1213
## Proposed Enhancement
14+
1315
Provide a clear description of what you'd like to see added or changed in the policy framework.
1416

1517
## Implementation Considerations
18+
1619
- How this fits with existing policy principles
1720
- Potential adoption challenges
1821
- Compatibility with different project types
1922
- Examples of where this would be beneficial
2023

2124
## Use Case Context
25+
2226
Describe real-world scenarios where this enhancement would help:
27+
2328
- Project type and size
2429
- Platform (GitHub, GitLab, internal tools)
2530
- Specific challenges addressed
2631

2732
## Additional Context
33+
2834
Include any other relevant information, examples from other policies, or references.
2935

3036
---
31-
**Note:** This project follows the [Bounded Contribution Policy](../../CODE_OF_CONDUCT.md). Please ensure your request aligns with our technical objectives and focus areas.
37+
**Note:** This project follows the [Bounded Contribution Policy](../../CODE_OF_CONDUCT.md).
38+
Please ensure your request aligns with our technical objectives and focus areas.

.github/ISSUE_TEMPLATE/policy_clarification.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,28 @@ assignees: ''
77
---
88

99
## Area of Clarification
10+
1011
Specify which aspect of the policy needs clarification or improvement.
1112

1213
## Current Understanding
14+
1315
Describe your current interpretation of the policy section.
1416

1517
## Proposed Clarification
18+
1619
Suggest specific wording or examples that would improve clarity.
1720

1821
## Use Case Context
22+
1923
Explain the project type or situation where this clarification would be helpful:
24+
2025
- Project size (small team, large community, etc.)
2126
- Platform (GitHub, GitLab, internal tools, etc.)
2227
- Domain (open source library, research project, etc.)
2328

2429
## Implementation Considerations
30+
2531
Any thoughts on how this should be implemented or potential challenges.
2632

2733
---
28-
**Note:** This repository focuses on practical improvements to the Bounded Contribution Policy framework. Please ensure your issue relates to policy implementation, clarification, or supporting resources.
34+
**Note:** This repository focuses on practical improvements to the Bounded Contribution Policy framework. Please ensure your issue relates to policy implementation, clarification, or supporting resources.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
1+
# Pull Request
2+
13
## Summary
4+
25
Brief description of the changes made to the policy framework.
36

7+
## Type of Change
8+
9+
- [ ] Policy clarification or improvement
10+
- [ ] New template or adoption resource
11+
- [ ] Documentation enhancement
12+
- [ ] Example addition or improvement
13+
- [ ] Technical infrastructure (linting, formatting, etc.)
14+
- [ ] Bug fix (broken link, typo, formatting issue)
15+
416
## Changes Made
17+
518
- [ ] Policy document updates
619
- [ ] Template additions/improvements
720
- [ ] Documentation enhancements
@@ -10,42 +23,75 @@ Brief description of the changes made to the policy framework.
1023
- [ ] Implementation resources
1124

1225
## Change Details
26+
1327
### What Changed
28+
1429
Describe the specific modifications made and why.
1530

1631
### Impact Assessment
32+
1733
- [ ] Maintains core policy principles
1834
- [ ] Compatible with existing implementations
1935
- [ ] Tested with different project types
2036
- [ ] Reviewed for clarity and practicality
2137
- [ ] Checked for unintended consequences
2238

39+
### Quality Assurance
40+
- [ ] All markdown files pass linting (`npm run lint:md`)
41+
- [ ] Line lengths follow project guidelines
42+
- [ ] Links are functional and point to correct resources
43+
- [ ] Language is neutral and professional
44+
- [ ] Humor (if used) reinforces project focus appropriately
45+
2346
### Validation
47+
2448
How have you validated these changes?
49+
2550
- [ ] Reviewed against real-world scenarios
2651
- [ ] Tested templates in example projects
2752
- [ ] Gathered feedback from potential adopters
2853
- [ ] Verified language clarity and neutrality
54+
- [ ] Changes tested in example scenario
2955

3056
## Review Focus Areas
57+
3158
Highlight specific areas where reviewer attention is needed:
59+
3260
- Policy consistency
3361
- Practical applicability
3462
- Language clarity
3563
- Potential adoption barriers
3664
- Cross-platform compatibility
3765

3866
## Verification Steps
67+
3968
Steps for reviewers to verify the changes:
40-
1.
41-
2.
42-
3.
69+
1.
70+
2.
71+
3.
4372

4473
## Documentation Updates
74+
4575
- [ ] Updated relevant documentation
4676
- [ ] Added examples where appropriate
4777
- [ ] Updated FAQ if needed
4878
- [ ] Checked cross-references and links
79+
- [ ] CHANGELOG.md updated with changes
80+
- [ ] Version number updated if applicable
81+
82+
## Additional Context
83+
84+
<!-- Include any additional context, related issues, or background information -->
85+
86+
## Related Issues
87+
88+
<!-- Link any related issues: Closes #123, Addresses #456, Related to #789 -->
4989

5090
---
51-
**Policy Compliance:** This contribution follows the [Bounded Contribution Policy](../CODE_OF_CONDUCT.md) with focus on technical value and project relevance.
91+
**Policy Compliance:** This contribution follows the [Bounded Contribution Policy](../CODE_OF_CONDUCT.md) with focus on technical value and project relevance.
92+
93+
<!--
94+
For maintainers: Remember the "Sir, this is a Wendy's" principle -
95+
keep discussions focused on the practical aspects of policy implementation
96+
rather than philosophical debates about contribution policies in general.
97+
-->
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Quality Checks
2+
3+
on:
4+
push:
5+
branches: [ master, main ]
6+
pull_request:
7+
branches: [ master, main ]
8+
9+
jobs:
10+
pre-commit:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v4
16+
17+
- name: Setup Python
18+
uses: actions/setup-python@v5
19+
with:
20+
python-version: '3.x'
21+
22+
- name: Setup Node.js
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: '18'
26+
cache: 'npm'
27+
28+
- name: Install npm dependencies
29+
run: npm ci
30+
31+
- name: Run pre-commit
32+
uses: pre-commit/action@v3.0.1
33+
34+
verify:
35+
runs-on: ubuntu-latest
36+
needs: pre-commit
37+
38+
steps:
39+
- name: Checkout repository
40+
uses: actions/checkout@v4
41+
42+
- name: Verify policy file exists
43+
run: |
44+
if [ ! -f "CODE_OF_CONDUCT.md" ]; then
45+
echo "❌ CODE_OF_CONDUCT.md (Bounded Contribution Policy) is missing"
46+
exit 1
47+
fi
48+
echo "✅ Bounded Contribution Policy found"
49+
50+
- name: Check for broken internal links
51+
run: |
52+
echo "Checking for broken internal markdown links..."
53+
# Simple check for common broken link patterns
54+
if grep -r "\]\(.*\.md\)" . --include="*.md" | grep -E "\]\([^)]*BOUNDED_CONTRIBUTION_POLICY\.md"; then
55+
echo "❌ Found references to old BOUNDED_CONTRIBUTION_POLICY.md file"
56+
exit 1
57+
fi
58+
echo "✅ No broken internal links found"

.gitignore

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Node.js
2+
node_modules/
3+
npm-debug.log*
4+
yarn-debug.log*
5+
yarn-error.log*
6+
7+
# OS generated files
8+
.DS_Store
9+
.DS_Store?
10+
._*
11+
.Spotlight-V100
12+
.Trashes
13+
ehthumbs.db
14+
Thumbs.db
15+
16+
# Editor files
17+
.vscode/
18+
.idea/
19+
*.swp
20+
*.swo
21+
*~
22+
23+
# Logs
24+
logs
25+
*.log
26+
27+
# Temporary files
28+
*.tmp
29+
*.temp

0 commit comments

Comments
 (0)