maplelabs / maplelabs/apm-github-plugin

Create CONTRIBUTION.md explaining the process of contribution to this project

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Go
Stars
0
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Contributing guidelines in GitHub itself.

What to implement: List of tasks:
How to create tasks.
How to assign tasks.
Who creates task, task prioritization.

Implement and Commit the changes
How to identify a task/feature/sub project
Communication and discussions mechanism
Unit test mechanism
Code quality or guidelines
Merge criteria

Tracking the progress of tasks
Expected date completion.
track dependencies between modules implemented by two committers

Build, QA and release process

We should cover all aspects of the project. One is for committers and another set of guidelines for maintainers for management of this repo.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Create CONTRIBUTION.md as requested. Start by reviewing the contribution and project-management practices described in the issue, then define the guidance for task creation, assignment, prioritization, implementation, testing, quality, merging, progress tracking, dependencies, QA, and release. Done means the document covers separate guidance for committers and maintainers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.