sourcejs/Source

rename stuff like options.js and /assets/ to names more sourcejs related

Open

#229 opened on May 28, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (552 stars) (49 forks)batch import
good first contributionhelp wanted

Description

Now that install by dependency is going to become the official way and the only way in 0.7.x I think we should think about being a bit less invasive upon people's environment.

Imagine if every npm dependency just asked to add a options.js to the root of the folder? I propose we rename it to something like sourcejs.config.js if that's possible.

Also I think all template-overrides, assets overrides and core-overrides could be in a sourcejs folder by default, instead of in the root. Another options would be to rename them to sourcejs-assets, sourcejs-templates.. etc.

Contributor guide

Tech stack
javascriptnodejs
Domain
frontenddeveloper experiencetooling
Issue type
refactor
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
SourceJS project structurenpm package configurationJavaScript/Node.js basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by examining the current root directory for files like options.js and folders named assets, templates, core overrides. Identify all imports or references to these files and folders in the codebase, particularly in configuration files and module loading. Rename options.js to sourcejs.config.js and move overrides into a sourcejs/ subdirectory, updating all internal references. Check the repository's wiki or documentation for any mentions of these paths.