tbreuss / mithril-by-examples

Learn Mithril.js by seeing, reviewing, and running up-to-date code examples
https://mithril-by-examples.js.org
MIT License
10 stars 8 forks source link

Add how to contribute page #20

Closed tbreuss closed 3 years ago

tbreuss commented 3 years ago

Add a "How to Contribute" page with all of the information a user needs to know in order to contribute to this repository.

kannanjayachandran commented 3 years ago

Do you mean the how to contribute read me file? If so, can I try this ?

tbreuss commented 3 years ago

Do you mean the how to contribute read me file? If so, can I try this ?

Yes, I mean a separate contribute file, more or less.

A few points to note (ordered by priority):

  1. the format of the file must be a markdown file, it must be excluded from rendering here
  2. the main information within this file should focus on how to contribute a Mithril example
  3. a Mithril example is defined in a markdown file within the examples folder
  4. in this contribute file should be a link to one or more concrete example
  5. in the readme.md should be a link to the new contribute.md and a short explanation (standard)
  6. it should give information about the tooling behind, that it is a static site generator (SSG) made with https://www.11ty.dev, for example
  7. it should give information about how to contribute for the whole project, too. But this is not the main focus.

If you could prepare a standard contribute file, that would be great.

In the meantime, I can give you some more information regarding the first four points from above, hopefully.

I'll assign you the issue, okay?

tbreuss commented 3 years ago

BTW: I'm working on this (#21) which could then be referenced from your contribute.md

kannanjayachandran commented 3 years ago

Hi I made a standard one, can you suggest what changes should I make in this ? Screenshot (33)

kannanjayachandran commented 3 years ago

I am making a pull request, if you want any additions please inform me.

tbreuss commented 3 years ago

Thanks, I let you know.