NaturalIntelligence / NaturalIntelligence/imglab

Update development guidelines

Open
#111 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement first-timers-only good first issue Hacktoberfest
Dominant language
HTML
Stars
1k
Forks
613
PR merge metrics
No merged PRs in 30d

Description

We created technical.md to help new developers to understand the project structure and it's component better. However as the new features are being added, and existing code is being refactored, we need to improve the guideline.

Watch for changes, or Bookmark for easy discovery.
Fund this project for new features and maintenance.
[Showcase] your project with us by raising an issue


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

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

Start by reading docs/technical.md, then compare its project-structure and component guidance with the current repository and its newer features and refactors. Done means the guidelines accurately describe the current project structure and components for new developers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.