Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a Roadmap to the project documentation #16

Open
DennisClark opened this issue Jun 11, 2019 · 14 comments
Open

Add a Roadmap to the project documentation #16

DennisClark opened this issue Jun 11, 2019 · 14 comments
Assignees

Comments

@DennisClark
Copy link
Member

Per @mjherzog
Roadmap might be one item that should be a file on primary repo like README

Assigned to @DennisClark to investigate

@DennisClark
Copy link
Member Author

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
Copy link
Member

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
Copy link
Contributor

@AyanSinhaMahapatra Lets leave this issue open until we create new "Add roadmap" tickets to all of our OSS repos.

AyanSinhaMahapatra pushed a commit that referenced this issue Mar 30, 2022
@inbuilt-aura
Copy link

@mjherzog, plzz assign me thios issue.Iwould love to contribute in this by makjing a roadmap as a readme file.

@pombredanne
Copy link
Member

@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
Copy link

inbuilt-aura commented Feb 10, 2023 via email

@ashutosh887
Copy link

@pombredanne I would like to work on this if not already worked upon by some fellow contributor

@krishna9358
Copy link

@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
Copy link

@pombredanne I would like to work on this if not already worked upon by some fellow contributor

cc: @DennisClark

@vHarshita15
Copy link

I WANT TO CONTRIBUTE ON THIS ISSUE

@pombredanne
Copy link
Member

@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
Copy link

vHarshita15 commented Nov 5, 2024 via email

@pombredanne
Copy link
Member

@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
Copy link

vHarshita15 commented Nov 6, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants