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

Make the project open #56

Closed
Heloisecs opened this issue Sep 21, 2018 · 2 comments
Closed

Make the project open #56

Heloisecs opened this issue Sep 21, 2018 · 2 comments
Assignees
Labels
documentation Creating documentation for users and artists, and formal reports Epic

Comments

@Heloisecs
Copy link
Contributor

Heloisecs commented Sep 21, 2018

We are trying to make Jandig more open for contributors since now (this is a priority)

  1. Create a good README.md
  2. Create Developers.md
  3. Create Artists.md
  4. Create Workflow.md
  5. Create public Roadmap (example: Roadmap KirstieJane/STEMMRoleModels#1 )
  6. Make releases and pre releases

Comments from mentor:
Pranshu: I'd recommend using GitHub's Release tools where you can even use 'Pre-Release' tags until you release it as a product. You can find how to do that here:https://help.github.com/articles/creating-releases/

So, that was for Release Notes for which we have a feature on GitHub but for some other things we can add all of those under ReadMe(which can be confusing for a visitor) or we can structure it like a Webpage where we use a couple of more markdown files, let's say, Developers.md and Artists.md with instructions for them to work on and a Workflow.md to explain how they can contribute and just add those links in the ReadMe. Tutorials come under a different folder, and a generic explanation of the project is what a visitor will be greeted with from the start and they can scroll down to try out prototypes, to test a few and report bugs, to develop, to make art, etc.

@vjpixel vjpixel added the documentation Creating documentation for users and artists, and formal reports label Sep 21, 2018
@vjpixel
Copy link
Member

vjpixel commented Sep 21, 2018

Great!

I think this is an epic, so I'll mark it this way.

I propose we create one issue for each document.

@vjpixel vjpixel added the Epic label Sep 21, 2018
@vjpixel
Copy link
Member

vjpixel commented Jun 8, 2019

can you please review @pablodiegoss ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Creating documentation for users and artists, and formal reports Epic
Projects
None yet
Development

No branches or pull requests

4 participants