Skip to content

Commit 768a0ca

Browse files
committed
Simplify CONTRIBUTING.md and add version bump requirement
- Remove issue reporting section (not actively monitored) - Add clear versioning requirement for PRs - Explain GitHub Actions release behavior - Streamline before-you-start section
1 parent 7dbced7 commit 768a0ca

1 file changed

Lines changed: 16 additions & 38 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,13 @@
11
# Contributing to Google Analytics Plugin for dotCMS
22

3-
Thank you for your interest in contributing to the Google Analytics plugin! This document provides guidelines and instructions for contributing.
3+
Thank you for your interest in contributing! We welcome pull requests that improve the plugin.
44

5-
## Code of Conduct
6-
7-
By participating in this project, you agree to abide by the dotCMS [Code of Conduct](https://dotcms.com/code-of-conduct). Please be respectful and constructive in all interactions.
8-
9-
## How Can I Contribute?
10-
11-
### Reporting Bugs
12-
13-
Before creating a bug report:
14-
- Check the [existing issues](https://github.com/dotCMS/google-analytics/issues) to avoid duplicates
15-
- Verify you're using the latest version of the plugin
16-
- Test with a clean dotCMS installation if possible
17-
18-
When creating a bug report, include:
19-
- **Plugin version** (e.g., 0.4.1)
20-
- **dotCMS version** (e.g., 23.01.10)
21-
- **Steps to reproduce** the issue
22-
- **Expected behavior** vs. **actual behavior**
23-
- **Error messages** from dotCMS logs
24-
- **Sample Velocity code** that demonstrates the issue
25-
26-
### Suggesting Enhancements
27-
28-
Enhancement suggestions are welcome! Please include:
29-
- **Clear use case** - What problem does this solve?
30-
- **Proposed solution** - How should it work?
31-
- **Alternatives considered** - What other approaches did you think about?
32-
- **Impact** - Who benefits from this enhancement?
33-
34-
### Pull Requests
35-
36-
We actively welcome pull requests!
5+
## Pull Requests
376

387
#### Before You Start
398

40-
1. **Check existing issues/PRs** - Someone might already be working on it
41-
2. **Open an issue first** for significant changes to discuss the approach
42-
3. **Keep changes focused** - One feature/fix per PR
9+
1. **Keep changes focused** - One feature/fix per PR
10+
2. **Fork the repository** - Work on your own fork
4311

4412
#### Development Setup
4513

@@ -181,7 +149,18 @@ This plugin follows [Semantic Versioning](https://semver.org/):
181149
- **Minor (0.X.0)**: New features, backward compatible
182150
- **Patch (0.0.X)**: Bug fixes, backward compatible
183151

184-
Version is managed in `build.gradle`. Don't change it in your PR unless coordinating with maintainers.
152+
**IMPORTANT:** Bump the version in `build.gradle` for each PR that should trigger a new release:
153+
154+
```gradle
155+
version = '0.4.2' // Increment for your changes
156+
```
157+
158+
When merged to main, GitHub Actions will:
159+
1. Check if release `v0.4.2` exists
160+
2. If not, build the JAR and create the release
161+
3. If yes, skip release creation (no duplicates)
162+
163+
**Always bump the version** to ensure your changes are trackable in releases.
185164

186165
## Release Process
187166

@@ -197,7 +176,6 @@ Only maintainers can merge to `main` and trigger releases.
197176
## Questions?
198177

199178
- **General questions**: [dotCMS Community Forums](https://dotcms.com/forums)
200-
- **Plugin-specific**: [Open an issue](https://github.com/dotCMS/google-analytics/issues)
201179
- **dotCMS development**: [dotCMS Developer Docs](https://dotcms.com/docs)
202180

203181
## License

0 commit comments

Comments
 (0)