Repository navigation
Add a Roadmap to the project documentation #16
Description
Per @mjherzog
Roadmap might be one item that should be a file on primary repo like README
Assigned to @DennisClark to investigate
{{ message }}
Per @mjherzog
Roadmap might be one item that should be a file on primary repo like README
Assigned to @DennisClark to investigate
Activity
DennisClark commentedon Jun 12, 2019
From @mjherzog
I see that as a planning doc that probably needs to be updated separately from other doc. Keeping it on the wiki is also a possibility. In any case we need a standard across projects/repos
mjherzog commentedon Jun 12, 2019
Overall, we need to set a standard for the few documents, like README, that need to be in the primary code tree versus the majority that belong under /docs. I think that ROADMAP should probably be in the main code tree because it is tied closely to Issues and Milestones, rather than HowTo etc.
Another option is to continue using the Wiki for the Roadmap, but it would be simpler to have all doc in the main code tree or /doc.
steven-esser commentedon Oct 24, 2019
@AyanSinhaMahapatra Lets leave this issue open until we create new "Add roadmap" tickets to all of our OSS repos.
Merge pull request #16 from AyanSinhaMahapatra/add-basic-docs
inbuilt-aura commentedon Feb 7, 2023
@mjherzog, plzz assign me thios issue.Iwould love to contribute in this by makjing a roadmap as a readme file.
pombredanne commentedon Feb 10, 2023
@inbuilt-aura we do not "assign" issues, you are just welcomed to work on one!
But here the roadmaps is not something you can likely take up as an issue anyway: this is rather a task for the core project contributors and maintainers as they are the only ones that can craft the right content for the ROADMAP.
inbuilt-aura commentedon Feb 10, 2023
ashutosh887 commentedon Feb 25, 2023
@pombredanne I would like to work on this if not already worked upon by some fellow contributor
krishna9358 commentedon May 3, 2023
@DennisClark I would love to give my hand in this task. With the right guidance, i think i can make the road map as README file.
ashutosh887 commentedon May 3, 2023
cc: @DennisClark
vHarshita15 commentedon Nov 4, 2024
I WANT TO CONTRIBUTE ON THIS ISSUE
pombredanne commentedon Nov 5, 2024
@vHarshita15 Thanks for you enthusiasm, but creating the roadmap is the privilege of the core contributors and maintainers of the project. The "documentation" part is the easy part, the content is the hard part.
vHarshita15 commentedon Nov 5, 2024
pombredanne commentedon Nov 6, 2024
@vHarshita15 you may want to avoid all caps for a start. These are often considered the written equivalent of screaming. See https://en.wikipedia.org/wiki/All_caps
Then this issue is not open yet to external contribution. The content has to be created by the core contributors of AboutCode in the first place.
See https://aboutcode.readthedocs.io/en/latest/contributing.html for a start.
vHarshita15 commentedon Nov 6, 2024
dantubhavyasree commentedon Sep 6, 2026
hey,
i read and understood issue
i wanted to work on this issue
could you assign it to me?
nt5504289-oss commentedon Sep 25, 2026
HELLO SIR I WOULD LIKE TO SOLVE THIS ISSUE
nt5504289-oss commentedon Sep 26, 2026
Hi! I'd like to work on this issue. Should the roadmap describe the overall direction of the AboutCode ecosystem, the development plans of individual AboutCode projects, or the roadmap for this repository? Also, are there any existing plans or milestones that should be included?
Saurav-techy commentedon Nov 7, 2026
@pombredanne @mjherzog hello Sir, i found this issuee and i want to contribute further , con please confirm that is this still open or necessary so that i can perpare for this issue.
Thanks.