add short section on contributing to README

[japhir]

as discussed in the stream, would be nice to have a section on how to contribute.

[japhir]

or as a separate CONTRIBUTING.(org|md) file

[japhir]

• here is how Doom does it
• spacemacs has a separate file

[japhir]

I wrote a first draft, feel free to give feedback or to improve it :)

[omarcospo]

Making a pattern of modules would be nice to have everything cohesive, so newcomers know how to create new modules. E.g:

;;; rational-<module-name>.el --- <Little description> -*- lexical-binding: t; -*-

< Start module >

(provide 'rational-<module-name>)

And maybe an org file with the module's documentation.

[daviwil]

@mfxarc A section on "Creating new modules" would be nice! Org files for module documentation would also be great, but it'd be nice if we could generate those from the source of the modules so that we wouldn't have to keep things up to date in 2 places.

[ajxn]

Wouldn't it be better if the pattern was how Emacs (and elisp mode) like to have descriptions in files?

Or even have a yasnippet or something like that added, with this as a snippet?

[daviwil]

We should definitely have expanded descriptions in the source files, just haven't gotten to that yet. I think we could add a Skeleton (or some other form of Emacs auto-insert) to create a new file template that can be called up from within this configuration:

https://www.gnu.org/software/emacs/manual/html_node/autotype/Autoinserting.html

[shubham-cpp]

The Principles links follows to page not found(In the contributing section)

[japhir]

Yeah I noticed this this morning as well. Kind of annoying because it's a valid org link :(

[japhir]

Also, the second little elisp-style button isn't working somehow. Perhaps because there's a space (%20) in it?

[japhir]

Fixed those two issues in #21 and #22 :) (sometimes using the web interface is quicker)

[daviwil]

Thanks @japhir!