docs(DCP-2585): add CONTRIBUTING.md and update cross-references#373
Merged
script-this merged 2 commits intomainfrom Mar 20, 2026
Merged
docs(DCP-2585): add CONTRIBUTING.md and update cross-references#373script-this merged 2 commits intomainfrom
script-this merged 2 commits intomainfrom
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
4312758 to
945475f
Compare
1f1f2e7 to
f89881e
Compare
MrManning
reviewed
Mar 20, 2026
CONTRIBUTING.md
Outdated
Comment on lines
+40
to
+44
| Use [GitHub Discussions](https://github.com/prolific-oss/cli/discussions) for questions, ideas, and general conversation. Keep [Issues](https://github.com/prolific-oss/cli/issues) for bug reports and feature requests. | ||
|
|
||
| ## Discuss Before You Code | ||
|
|
||
| For non-trivial changes, please open an issue first to discuss your approach. This avoids wasted effort if the change doesn't align with the project's direction or if someone else is already working on it. Small fixes (typos, one-line bug fixes) can go straight to a PR. |
Contributor
There was a problem hiding this comment.
We say discussions for general convo but then say to open an issue to discuss changes. Might be just a wording thing here. If I have a non-trivial change should I:
- start a discussion first to ensure it aligns with the project
- OR create an issue and mark as a feature request
MrManning
reviewed
Mar 20, 2026
|
|
||
| ## Reporting Bugs | ||
|
|
||
| [Open an issue](https://github.com/prolific-oss/cli/issues/new) to report bugs (issue templates coming soon). A good bug report includes: |
Contributor
There was a problem hiding this comment.
One for later if we don't have it already but definitely nice to have an issue template for people to fill out
Contributor
Author
There was a problem hiding this comment.
Good shout, toyed with adding that + PR + feature templates in this but I'll add follow ticket on to phase 3 / 4 CLI epic for it.
MrManning
approved these changes
Mar 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a comprehensive CONTRIBUTING.md to the Prolific CLI, welcoming external contributors and setting expectations for the contribution process. Links to DEVELOPMENT.md for detailed development guidance rather than duplicating content.
CONTRIBUTING.md
Covers:
Issue templates and PR template are noted as coming soon — will be added in a follow-up to ensure they work well for both external contributors and internal staff.
Cross-references