Skip to content

Update documentation and add Rewardful plugin to external plugins list #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
iloveitaly wants to merge 5 commits into from
+122 −87
Closed

Update documentation and add Rewardful plugin to external plugins list #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
86073a4
Add Rewardful plugin to external plugins list
claude Nov 26, 2025
6ecb491
Update README with Rewardful plugin
claude Nov 27, 2025
3f06094
Update plugin READMEs
claude Nov 27, 2025
48fe6a1
Add package-lock.json to .gitignore
claude Nov 27, 2025
28015d0
Document docs generation command in CONTRIBUTING.md
claude Nov 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ node_modules
.size-snapshot.json
*.log
.netlify
package-lock.json

_misc

Expand Down
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,23 @@ Runs all the `analytics` packages tests.
pnpm run test
```

### `docs`

Regenerates auto-generated content in README files, including the plugin lists, API documentation, and table of contents.

**When to run:**
- After modifying `external-plugins.json` (to update the Community Plugins list)
- After changing API documentation in source code
- After updating JSDoc comments

#### Usage

```sh
npm run docs
```

**Note:** This command uses `markdown-magic` to process `<!-- AUTO-GENERATED-CONTENT:START -->` markers in README files. If you don't have dependencies installed, run `npm install --legacy-peer-deps` first.

## Pull Requests

We actively welcome your pull requests!
Expand All @@ -122,7 +139,7 @@ Analytics uses the [Forking Workflow](https://www.atlassian.com/git/tutorials/co
1. Fork the repo.
2. Create a branch from `master`. If you're addressing a specific issue, prefix your branch name with the issue number.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
3. If you've changed APIs, update the documentation. If you've modified `external-plugins.json`, run `npm run docs` to regenerate the README files.
4. Run `pnpm run test` and ensure the test suite passes.
6. PR's must be rebased before merge (feel free to ask for help).
7. PR should be reviewed by two maintainers prior to merging.
Expand Down
Loading