Skip to content

Commit 9d27212

Browse files
committed
Add MELPA-ELPA.org file that explains how to upgrade the matlab pkg in ELPA
--HG-- branch : matlab-ts-mode
1 parent d39895c commit 9d27212

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

contributing/MELPA-ELPA.org

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
* MELPA
2+
3+
** Configuration
4+
5+
*** Information
6+
The logic is simple: there is a recipe file that specifies which subdirectories and files to use from the repository.
7+
[[file:~/ALLES/src/matlab-recip.patch][file:~/ALLES/src/matlab-recip.patch]]
8+
9+
*** lisp
10+
#+begin_src elisp :noexport
11+
(defconst package-build-default-files-spec
12+
'("*.el" "lisp/*.el"
13+
"dir" "*.info" "*.texi" "*.texinfo"
14+
"doc/dir" "doc/*.info" "doc/*.texi" "doc/*.texinfo"
15+
"docs/dir" "docs/*.info" "docs/*.texi" "docs/*.texinfo"
16+
(:exclude
17+
".dir-locals.el" "lisp/.dir-locals.el"
18+
"test.el" "tests.el" "*-test.el" "*-tests.el"
19+
"lisp/test.el" "lisp/tests.el" "lisp/*-test.el" "lisp/*-tests.el"))
20+
"Default value for `:files' attribute in recipes.")
21+
#+end_src
22+
23+
*** Fork and set up
24+
To contribute to MELPA:
25+
1. Fork the melpa directory to your local repository using the provided button.
26+
2. Clone it locally.
27+
3. Edit and commit your changes.
28+
4. Test using `make recipes/matlab-mode`, comparing the generated tar file with your version.
29+
5. Push your changes.
30+
6. In the repository, use the highlighted yellow indicators to compare and submit a pull request.
31+
32+
** Actualise
33+
Every push to our GitHub repository triggers an automatic release in MELPA, using the current date as the reference.
34+
35+
Example
36+
#+begin_src
37+
matlab-mode 20250529.56 available melpa Major mode for MATLAB(R) dot-m files
38+
#+end_src
39+
40+
* ELPA
41+
42+
ELPA is configured.
43+
44+
The current configuration resides in `=.elpaignore=`, which may be updated if the need arises.
45+
46+
However, to issue a new release, the version number must be explicitly changed in the relevant file—currently `matlab.el`.
47+
48+
Relevant lines:
49+
#+begin_src
50+
;;; matlab.el --- major mode for MATLAB(R) dot-m files -*- lexical-binding: t -*-
51+
52+
;; Copyright (C) 1991-2025 Free Software Foundation, Inc.
53+
54+
;; Version: 6.3
55+
#+end_src
56+
57+
It is also prudent to update the header in `matlab-mode.el`:
58+
#+begin_src
59+
;;; matlab-mode.el --- Major mode for MATLAB(R) dot-m files -*- lexical-binding: t -*-
60+
61+
;; Copyright (C) 2024 Free Software Foundation, Inc.
62+
63+
;; Version: 6.3
64+
;; URL: https://github.com/mathworks/Emacs-MATLAB-Mode
65+
;; SPDX-License-Identifier: GPL-3.0-or-later
66+
#+end_src
67+
68+

0 commit comments

Comments
 (0)