Skip to content

Commit 3a62d3f

Browse files
authored
docs: Add contribute section
1 parent 1a7f2b2 commit 3a62d3f

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

README.org

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,73 @@ It adds two functions ~ace-link-dashboard~ to trigger default action and
2222
("o" . ace-link-dashboard)
2323
("d" . ace-link-dashboard-remove)))
2424
#+end_src
25+
26+
** 🛠️ Contribute
27+
28+
[[http://makeapullrequest.com][https://img.shields.io/badge/PRs-welcome-brightgreen.svg]]
29+
[[https://github.com/bbatsov/emacs-lisp-style-guide][https://img.shields.io/badge/elisp-style%20guide-purple.svg]]
30+
31+
If you would like to contribute to this project, you may either
32+
clone and make pull requests to this repository. Or you can
33+
clone the project and establish your own branch of this tool.
34+
Any methods are welcome!
35+
36+
*** 🔬 Development
37+
38+
To run the test locally, you will need the following tools:
39+
40+
- [[https://emacs-eask.github.io/][Eask]]
41+
- [[https://www.gnu.org/software/make/][Make]] (optional)
42+
43+
Install all dependencies and development dependencies:
44+
45+
#+begin_src sh
46+
$ eask install-deps --dev
47+
#+end_src
48+
49+
To test the package's installation:
50+
51+
#+begin_src sh
52+
$ eask package
53+
$ eask install
54+
#+end_src
55+
56+
To test compilation:
57+
58+
#+begin_src sh
59+
$ eask compile
60+
#+end_src
61+
62+
🪧 The following steps are optional, but we recommend you follow these lint results!
63+
64+
The built-in =checkdoc= linter:
65+
66+
#+begin_src sh
67+
$ eask lint checkdoc
68+
#+end_src
69+
70+
The standard =package= linter:
71+
72+
#+begin_src sh
73+
$ eask lint package
74+
#+end_src
75+
76+
📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.
77+
78+
** ⚜️ License
79+
80+
This program is free software; you can redistribute it and/or modify
81+
it under the terms of the GNU General Public License as published by
82+
the Free Software Foundation, either version 3 of the License, or
83+
(at your option) any later version.
84+
85+
This program is distributed in the hope that it will be useful,
86+
but WITHOUT ANY WARRANTY; without even the implied warranty of
87+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
88+
GNU General Public License for more details.
89+
90+
You should have received a copy of the GNU General Public License
91+
along with this program. If not, see <https://www.gnu.org/licenses/>.
92+
93+
See [[./LICENSE][LICENSE]] for details.
94+

0 commit comments

Comments
 (0)