Comments (12)
I wrote a first draft, feel free to give feedback or to improve it :)
from crafted-emacs.
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
from crafted-emacs.
or as a separate CONTRIBUTING.(org|md) file
from crafted-emacs.
from crafted-emacs.
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.
from crafted-emacs.
@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.
from crafted-emacs.
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?
from crafted-emacs.
The Principles links follows to page not found(In the contributing section)
from crafted-emacs.
Yeah I noticed this this morning as well. Kind of annoying because it's a valid org link :(
from crafted-emacs.
Also, the second little elisp-style button isn't working somehow. Perhaps because there's a space (%20
) in it?
from crafted-emacs.
Fixed those two issues in #21 and #22 :) (sometimes using the web interface is quicker)
from crafted-emacs.
Thanks @japhir!
from crafted-emacs.
Related Issues (20)
- [craftedv2beta] Broken configuration guards (Tracking Issue) HOT 4
- [craftedv2beta] Improve documentation for using straight.el HOT 7
- Provide option for easier module loading. HOT 7
- [craftedv2beta] Use `customize-save-variable` vs. `customize-set-variable`? HOT 11
- [craftedv2beta] Question regarding the skeleton for new modules HOT 5
- Discussion: When do our own `defcustom` variables make sense? When are they best avoided? HOT 6
- [craftedv2beta] Evil bindings in crafted-speedbar are duplicate and inconsistent with evil-collection HOT 3
- [craftedv2beta] Standardized way for naming functions HOT 5
- [craftedv2beta] Unused function `crafted-completion/minibuffer-backward-kill` HOT 2
- texinfo tags in doc headings don't seem to be needed HOT 3
- [v2] Emacs 29+ check for executable prevents Treesitter setup HOT 12
- [v2] No easy way to opt out of tree sitter parsers HOT 5
- [v2] Corfu + Eglot have unsuitable performance for medium/large projects HOT 4
- [v2] defgroup crafted-startup not functioning properly
- [v2]package-selected-packages "Combobulate" problem. HOT 3
- Automating regeneration of Info file HOT 13
- Suggestion: Make examples loadable HOT 3
- Symbol's function definition is void: treesit-auto-add-to-auto-mode-alist HOT 3
- `crafted-init-config` automatically finding directory possibly confounded by submodule use HOT 9
- Eglot doesn't automatically load when a relevant mode is visited until explicitly required HOT 10
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from crafted-emacs.