Skip to content

Commit b24ca4b

Browse files
mistial-devmistial-dev
committed
Refactor templates and add humor to documentation
Major changes: - Rename BOUNDED_CONTRIBUTION_POLICY.md to CODE_OF_CONDUCT.md as canonical policy file - Add "Sir, this is a Wendy's" meme throughout docs for handling off-topic discussions - Restructure GitHub templates with proper YAML front matter and multiple issue types - Add flexibility guidance for adapting templates to different project types - Create changelog in docs/ directory tracking v1.0.0 to v1.1.0 - Update all documentation references to use CODE_OF_CONDUCT.md The policy now better follows GitHub best practices while maintaining focus on productive technical collaboration.
1 parent bc6da1b commit b24ca4b

20 files changed

+406
-141
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/adoption_guide.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Adoption Guide Request
3+
about: Request guidance for adopting the policy in specific contexts
4+
title: ''
5+
labels: adoption, guidance
6+
assignees: ''
7+
---
8+
9+
## Project Context
10+
Describe your project and community:
11+
- Project type: [e.g., open source library, research project, internal tool]
12+
- Community size: [e.g., 5-10 contributors, 100+ contributors]
13+
- Current governance: [e.g., none, informal, existing CoC]
14+
- Main challenges: [e.g., off-topic issues, heated debates, unclear boundaries]
15+
16+
## Adoption Goals
17+
What do you hope to achieve with the Bounded Contribution Policy?
18+
- [ ] Reduce off-topic discussions
19+
- [ ] Clarify contribution standards
20+
- [ ] Maintain technical focus
21+
- [ ] Establish clear boundaries
22+
- [ ] Other: [specify]
23+
24+
## Specific Questions
25+
List any specific questions about implementing the policy:
26+
1.
27+
2.
28+
3.
29+
30+
## Customization Needs
31+
Are there aspects of the policy that need adaptation for your context?
32+
33+
## Timeline
34+
When are you planning to implement this policy?
35+
36+
---
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.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Implementation Issue
3+
about: Report problems with policy implementation or template usage
4+
title: ''
5+
labels: bug, implementation
6+
assignees: ''
7+
---
8+
9+
## Issue Description
10+
Clear description of the implementation problem or template issue.
11+
12+
## Steps to Reproduce / Context
13+
1. Which template or policy section
14+
2. How it was implemented
15+
3. What went wrong
16+
17+
## Expected Outcome
18+
What should happen when implementing this policy/template.
19+
20+
## Actual Outcome
21+
What actually happens in practice.
22+
23+
## Implementation Context
24+
- Project type: [e.g., open source library, internal tool]
25+
- Platform: [e.g., GitHub, GitLab, Bitbucket]
26+
- Team size: [e.g., solo, small team, large community]
27+
- Specific template/section: [which part of the policy]
28+
29+
## Additional Information
30+
- Community feedback received
31+
- Workarounds attempted
32+
- Suggestions for improvement
33+
34+
---
35+
**Note:** Please focus on technical details and reproduction steps. See our [Bounded Contribution Policy](../../CODE_OF_CONDUCT.md) for contribution guidelines.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: General Discussions
4+
url: https://github.com/mistial-dev/BoundedContributionPolicy/discussions
5+
about: For general discussions about the Bounded Contribution Policy framework
6+
- name: Browse Templates
7+
url: https://github.com/mistial-dev/BoundedContributionPolicy/tree/main/adoption/templates
8+
about: View example templates for different platforms
9+
- name: Read the Full Policy
10+
url: https://github.com/mistial-dev/BoundedContributionPolicy/blob/main/BOUNDED_CONTRIBUTION_POLICY.md
11+
about: Understand the policy principles before contributing
12+
- name: Implementation Examples
13+
url: https://github.com/mistial-dev/BoundedContributionPolicy/blob/main/EXAMPLES.md
14+
about: See how others have implemented the policy

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Policy Enhancement
3+
about: Suggest improvements to the Bounded Contribution Policy framework
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Enhancement Objective
10+
Describe the specific policy gap or improvement opportunity.
11+
12+
## Proposed Enhancement
13+
Provide a clear description of what you'd like to see added or changed in the policy framework.
14+
15+
## Implementation Considerations
16+
- How this fits with existing policy principles
17+
- Potential adoption challenges
18+
- Compatibility with different project types
19+
- Examples of where this would be beneficial
20+
21+
## Use Case Context
22+
Describe real-world scenarios where this enhancement would help:
23+
- Project type and size
24+
- Platform (GitHub, GitLab, internal tools)
25+
- Specific challenges addressed
26+
27+
## Additional Context
28+
Include any other relevant information, examples from other policies, or references.
29+
30+
---
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.

‎.github/ISSUE_TEMPLATE/policy_clarification.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Policy Clarification
3+
about: Request clarification or suggest improvements to the Bounded Contribution Policy
4+
title: ''
5+
labels: documentation, policy
6+
assignees: ''
7+
---
8+
9+
## Area of Clarification
10+
Specify which aspect of the policy needs clarification or improvement.
11+
12+
## Current Understanding
13+
Describe your current interpretation of the policy section.
14+
15+
## Proposed Clarification
16+
Suggest specific wording or examples that would improve clarity.
17+
18+
## Use Case Context
19+
Explain the project type or situation where this clarification would be helpful:
20+
- Project size (small team, large community, etc.)
21+
- Platform (GitHub, GitLab, internal tools, etc.)
22+
- Domain (open source library, research project, etc.)
23+
24+
## Implementation Considerations
25+
Any thoughts on how this should be implemented or potential challenges.
26+
27+
---
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.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,45 @@
1-
# Pull Request
2-
31
## Summary
4-
Brief description of the changes made.
2+
Brief description of the changes made to the policy framework.
53

64
## Changes Made
75
- [ ] Policy document updates
86
- [ ] Template additions/improvements
97
- [ ] Documentation enhancements
10-
- [ ] Implementation guide updates
118
- [ ] Example additions
9+
- [ ] Adoption guide updates
10+
- [ ] Implementation resources
1211

13-
## Problem Addressed
14-
Describe the specific issue or improvement this addresses.
15-
16-
## Implementation Details
12+
## Change Details
1713
### What Changed
18-
Explain the specific modifications made.
19-
20-
### Why This Approach
21-
Describe the reasoning behind the implementation choices.
22-
23-
### Testing/Validation
24-
How have you verified these changes work as intended?
25-
- [ ] Tested templates with example projects
26-
- [ ] Reviewed language for clarity
27-
- [ ] Checked links and references
28-
- [ ] Validated against different project types
29-
30-
## Impact Assessment
31-
### Who Benefits
32-
Describe which types of projects or users will benefit from these changes.
33-
34-
### Compatibility
35-
- [ ] Maintains compatibility with existing implementations
36-
- [ ] No breaking changes to core principles
37-
- [ ] Works across different platforms and project types
14+
Describe the specific modifications made and why.
15+
16+
### Impact Assessment
17+
- [ ] Maintains core policy principles
18+
- [ ] Compatible with existing implementations
19+
- [ ] Tested with different project types
20+
- [ ] Reviewed for clarity and practicality
21+
- [ ] Checked for unintended consequences
22+
23+
### Validation
24+
How have you validated these changes?
25+
- [ ] Reviewed against real-world scenarios
26+
- [ ] Tested templates in example projects
27+
- [ ] Gathered feedback from potential adopters
28+
- [ ] Verified language clarity and neutrality
29+
30+
## Review Focus Areas
31+
Highlight specific areas where reviewer attention is needed:
32+
- Policy consistency
33+
- Practical applicability
34+
- Language clarity
35+
- Potential adoption barriers
36+
- Cross-platform compatibility
37+
38+
## Verification Steps
39+
Steps for reviewers to verify the changes:
40+
1.
41+
2.
42+
3.
3843

3944
## Documentation Updates
4045
- [ ] Updated relevant documentation
@@ -43,4 +48,4 @@ Describe which types of projects or users will benefit from these changes.
4348
- [ ] Checked cross-references and links
4449

4550
---
46-
**Policy Alignment:** This contribution maintains the Bounded Contribution Policy's focus on practical technical collaboration improvements while preserving core principles of neutrality and individual evaluation.
51+
**Policy Compliance:** This contribution follows the [Bounded Contribution Policy](../CODE_OF_CONDUCT.md) with focus on technical value and project relevance.

‎CHANGELOG.md‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

BOUNDED_CONTRIBUTION_POLICY.md renamed to CODE_OF_CONDUCT.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bounded Contribution Policy
22

3-
## Contribution and Discussion Policy
3+
## Our Standards
44

55
This project is dedicated to building and maintaining a specific technical product. To support that goal, all contributions and discussions must align with the following principles:
66

@@ -22,9 +22,19 @@ Project maintainers are not obligated to respond to all input. Engagement is pri
2222
### Neutral Environment
2323
This project maintains a neutral technical focus. Social, political, or ideological discussions are outside the project's scope. Participation must reflect this technical orientation.
2424

25-
### Enforcement
25+
## Enforcement
26+
2627
These principles will be applied consistently. Violations may result in rejection of contributions, removal of access, or other actions deemed necessary by project maintainers to maintain project focus.
2728

29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that do not align with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all project spaces, including but not limited to:
34+
- GitHub repository (issues, pull requests, discussions)
35+
- Project documentation
36+
- Community channels officially associated with the project
37+
2838
## Purpose
2939

30-
This policy provides a framework for maintaining focused, productive technical collaboration by establishing clear boundaries around project scope and contribution evaluation criteria.
40+
The Bounded Contribution Policy provides a framework for maintaining focused, productive technical collaboration by establishing clear boundaries around project scope and contribution evaluation criteria.

‎CONTRIBUTING.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
Thank you for your interest in improving the Bounded Contribution Policy. This document outlines how to contribute to the policy itself.
44

5+
## A Quick Reminder
6+
7+
![Sir, this is a Wendy's](res/images/wendys.jpg)
8+
9+
Just like our favorite fast-food meme reminds us, this repository has a specific purpose: **practical policy frameworks for focused technical collaboration**.
10+
11+
We're not here to:
12+
- Debate the philosophical implications of contribution boundaries
13+
- Discuss the greater socioeconomic ramifications of focused collaboration
14+
- Solve world peace through pull request templates
15+
16+
We ARE here to:
17+
- Make technical projects more focused and productive
18+
- Provide practical templates and guidance
19+
- Help maintainers avoid burnout from off-topic discussions
20+
521
## Contribution Guidelines
622

723
This project follows its own Bounded Contribution Policy, focusing on practical improvements to the policy framework and implementation resources.
@@ -34,6 +50,9 @@ This project follows its own Bounded Contribution Policy, focusing on practical
3450
- Addition of identity-based evaluation criteria
3551
- Expansion beyond technical contribution management
3652
- Complex governance structures or processes
53+
- Discussions about whether we should consider the differential effect of our policy on various communities (Sir, this is still a Wendy's)
54+
- Feature requests to track contributor demographics
55+
- Suggestions to add social impact assessments
3756

3857
## How to Contribute
3958

0 commit comments

Comments
 (0)