NaturalIntelligence/imglab

Update development guidelines

Open

#111 opened on Sep 23, 2018

View on GitHub
 (5 comments) (0 reactions) (0 assignees)HTML (930 stars) (560 forks)batch import
Hacktoberfestenhancementfirst-timers-onlygood first issue

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

Tech stack
htmljavascript
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with imglab project structureRead existing technical.mdBasic web development knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Start by reading the existing technical.md at docs/technical.md to understand the current state of the development guidelines. Then review recent code changes and new features in the imglab repository to identify what needs to be updated or added. Check the issue comments for any previous suggestions or feedback. Finally, propose an updated version of the guidelines that covers the project structure, component interactions, and setup instructions.