-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3029601
commit 65efa5b
Showing
3 changed files
with
41 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<!-- markdownlint-disable MD001 MD013 --> | ||
|
||
# Contributing | ||
|
||
Below are the ways you can contribute to this package. Thank you for giving your time to improve it. | ||
|
||
## [Issues](https://github.com/llemaitre19/jtsx/issues) | ||
|
||
Report bugs, request changes or enhancements, ... | ||
|
||
## [Discussions](https://github.com/llemaitre19/jtsx/discussions) | ||
|
||
Share ideas or suggestions, discuss functional or technical choices, ... | ||
|
||
## [Pull Requests](https://github.com/llemaitre19/jtsx/pulls) | ||
|
||
Contribute with your own code to the repository. | ||
|
||
### Writing code | ||
|
||
* Coding best practices: [Emacs Lisp style guide](https://github.com/bbatsov/emacs-lisp-style-guide). | ||
|
||
### Running tests locally (on your Emacs current version) | ||
|
||
* Install [Eask](https://emacs-eask.github.io/). | ||
* Run `make`. | ||
|
||
### Running tests locally across all supported versions of Emacs | ||
|
||
* Install the [Nix package manager](https://nixos.org/download/). | ||
* Run `make test_all`. | ||
|
||
### Checking Github test workflow | ||
|
||
* After pushing on your `jtsx` fork, go to `Actions` tab and check whether the test workflow has succeeded. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters