Skip to content

Commit fe74e1f

Browse files
jeffpauldkotter
andauthored
Add squash merge strategy to docs (#504)
* add squash merge strategy --------- Co-authored-by: Darin Kotter <darin.kotter@gmail.com>
1 parent 7b74298 commit fe74e1f

3 files changed

Lines changed: 18 additions & 31 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@ composer format && npm run lint:js:fix && npm run format
5050
npm run wp-env:test start -- --xdebug=coverage && npm run test:e2e && npm run test:php && npm run wp-env:test stop
5151
```
5252

53-
---
54-
5553
### Coding standards
5654

5755
All code must follow the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/). This ensures consistency across the WordPress ecosystem and makes the codebase maintainable.
@@ -144,14 +142,16 @@ echo 'Hello World';
144142
- As with all WordPress projects, we want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [Code of Conduct](https://make.wordpress.org/handbook/community-code-of-conduct/).
145143
- All WordPress projects are licensed under the GPLv2+, and all contributions to the AI plugin will be released under the GPLv2+ license. You maintain copyright over any contribution you make, and by submitting a pull request, you are agreeing to release that contribution under the GPLv2+ license.
146144

145+
---
146+
147147
## Additional resources
148148

149149
For more detailed information on plugin architecture, creating experiments, and development workflows, see:
150150

151151
- [Developer Guide](docs/DEVELOPER_GUIDE.md) - Comprehensive guide to plugin development
152152
- [Architecture Overview](docs/ARCHITECTURE_OVERVIEW.md) - Comprehensive guide to plugin architecture
153-
- [Release Instructions](docs/RELEASE_INSTRUCTIONS.md) - Checklist steps for releasing versions of the plugin
153+
- [Experiment Lifecycle](docs/EXPERIMENT_LIFECYCLE.md) - Defines how new Experiments land in the plugin and how they could graduate towards WordPress core
154154
- [Testing Strategy](docs/TESTING.md) - Testing philosophy and guidelines
155155
- [Testing API Strategy](docs/TESTING_REST_API.md) - Testing philosophy and guidelines
156-
- [Experiment Lifecycle](docs/EXPERIMENT_LIFECYCLE.md) - Defines how new Experiments land in the plugin and how they could graduate towards WordPress core
157-
- [WordPress AI Team](https://make.wordpress.org/ai/) - Community and discussion
156+
- [Example Experiment](../includes/Experiments/Example_Experiment/README.md) - Reference implementation
157+
- [Release Instructions](docs/RELEASE_INSTRUCTIONS.md) - Checklist steps for releasing versions of the plugin

‎docs/DEVELOPER_GUIDE.md‎

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,6 @@ class My_Experiment extends Abstract_Experiment {
181181
}
182182
```
183183

184-
---
185-
186184
## Plugin API
187185

188186
The plugin provides a set of hooks and filters to allow third-party developers to extend its functionality.
@@ -289,8 +287,6 @@ Asset_Loader::localize_script(
289287
);
290288
```
291289

292-
---
293-
294290
## Development Workflow
295291

296292
### 1. Create a Feature Branch
@@ -340,33 +336,25 @@ Push your branch and create a pull request. Follow the contribution guidelines i
340336
- Pull request requirements
341337
- Code review process
342338

339+
## Merge Strategy
340+
341+
This project makes use of squash merges from PR branches to the `develop` branch and as such we've disabled the "Allow merge commits" and "Allow rebase merging" in the repo so that anyone merging will be forced into the "Allow squash merging" approach.
342+
343+
Note that not every commit message should be kept in the resulting squash merge commit message, feel free to strip out unhelpful commit messages to keep the resulting squash merge commit message as concise as possible (e.g. get ride of those "lets try this again" commit messages).
344+
345+
An example of a squash merge from #359 can be seen in 4c9699f, while an example of the prior approach of a merge commit from #311 can be seen in e63d8c0.
346+
343347
---
344348

345349
## Additional Resources
346350

347-
### Documentation
351+
For more detailed information on plugin architecture, creating experiments, and development workflows, see:
348352

349353
- [Contributing Guidelines](../CONTRIBUTING.md) - Code standards and contribution process
354+
- [Architecture Overview](docs/ARCHITECTURE_OVERVIEW.md) - Comprehensive guide to plugin architecture
355+
- [Experiment Lifecycle](EXPERIMENT_LIFECYCLE.md) - Defines how new Experiments land in the plugin and how they could graduate towards WordPress core
350356
- [Testing Strategy](TESTING.md) – Testing philosophy and guidelines
351357
- [Testing REST API Strategy](TESTING_REST_API.md) – Guidelines specific to testing REST API integrations
358+
- [Example Experiment](../includes/Experiments/Example_Experiment/README.md) - Reference implementation
352359
- [Custom Experiment Reference](experiments/custom-experiment-reference.md) - Documented example for extending the plugin
353-
- [Example Experiment](../includes/Experiments/Example_Experiment/README.md) - In-repo reference implementation
354-
- [WordPress Plugin Handbook](https://developer.wordpress.org/plugins/)
355-
- [Experiment Lifecycle](EXPERIMENT_LIFECYCLE.md) - Defines how new Experiments land in the plugin and how they could graduate towards WordPress core
356-
- [WordPress AI Team](https://make.wordpress.org/ai/)
357-
358-
### Getting Help
359-
360-
- **GitHub Issues**: Report bugs or request features
361-
- **WordPress Slack**: Join the `#core-ai` channel in Slack, see the [WordPress Slack page](https://make.wordpress.org/chat/) for signup information; it is free to join.
362-
- **Make WordPress AI**: https://make.wordpress.org/ai/
363-
364-
---
365-
366-
## License
367-
368-
GPL-2.0-or-later
369-
370-
---
371-
372-
<br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
360+
- [Release Instructions](docs/RELEASE_INSTRUCTIONS.md) - Checklist steps for releasing versions of the plugin

‎docs/RELEASE_INSTRUCTIONS.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Release Instructions
32

43
The following can be copied into a [new, blank GitHub issue](https://github.com/WordPress/ai/issues) who's title is formatted as `Release version X.Y.Z`. Once the issue is submitted, the checklist in the body of the issue should be followed to release a new version of the AI plugin. All references to `X.Y.Z` below should be updated to the actual release version number.

0 commit comments

Comments
 (0)