Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 3.88 KB

contribution-points.md

File metadata and controls

31 lines (19 loc) · 3.88 KB
Raw

The Adobe Commerce Support Knowledge Base (KB) works with Magento Community Engineering teams and projects. As you contribute Pull Requests (PRs), you gain Contribution Points.

These earned points add to contributor totals for Magento contributions. Like Magento code and Magento DevDocs contributions, the Support KB team assesses the PRs and applies labels (which may vary between repositories) to determine the level of work and achievements to be awarded. Each PR receives one base achievement and potentially additional achievements.

These examples show how reward points are calculated:

  • A contributor who submits a PR that fixes a broken link or a typo will receive an Editorial (base achievement) label = 1 point.

  • A contributor who submits a PR containing missing details for troubleshooting steps or important symptoms, updates an image and similar will receive an Improvement (base achievement) label = 10 points and either a Major update (additional achievement) label = 20 points OR a Technical label (additional achievement) = 10 points

Base achievements

Every merged PR to the Support KB repository receives one base achievement. By default, it is "Improvement", but if changes are minor and qualify for "Editorial" instead, a team member would add the "Editorial" label, and it will replace the default Improvement achievement.

ACHIEVEMENT POINTS DESCRIPTION
Improvement 10 Contribution contains document improvements, adding missing details for troubleshooting steps or important symptoms, updating an image and similar. Any PR is considered an "Improvement" by default.
Editorial 1 Contribution contains fixes for typos, broken links, grammatical inconsistencies, or minor rewrites to correct inaccuracies.

Additional achievements

Each PR can earn one of the following additional achievements. If you entered an editorial PR, you may not receive an additional achievement.

ACHIEVEMENT POINTS DESCRIPTION
New topic 30 Adding a new topic that never existed in Knowledge Base, such as troubleshooting an issue that was not previously covered or a best practices article with significant amount of content.
Major update 20 Significant updates to existing content, including identifying that an issue can be solved through a version upgrade or alternative solution.
Technical 10 Updates to code or processes that alter the technical content of the document, such as code snippets, reference documentation, parameter names and values, adding a specific symptom the helps identify an issue and other relevant content.

If the PR earns recognition for significant updates and additions to the documentation, it may also receive a Special Achievement label, which garners an additional 20 points. This is determined at the time of internal assessment. Certain issues may already be labeled as Special Achievement in an effort to prompt contribution. The PRs that fix these issues will receive the extra 20 points.