@@ -3,14 +3,12 @@ Contributing to lua-filters
33
44Happy to have you here! Below you can find guidance on the
55best way to contribute to this collection of Lua filters.
6+ All contributions are welcome!
67
78Bugs reports and feature requests
89---------------------------------
910
10- All contributions are welcome!
11-
12-
13- Please report all bugs on the
11+ We are happy to receive feature request or bug reports on the
1412GitHub [ issue tracker] .
1513
1614Please note that all filters * usually* target the latest pandoc
@@ -73,6 +71,12 @@ The filters come with these components:
7371
7472All components should be bundled in a single directory.
7573
74+ Text and source files should always be terminated by a final
75+ newline character. The repository comes with a ` .editorconfig `
76+ file which helps to adhere to this and similar conventions. Please
77+ consider installing [ editorconfig] ( https://editorconfig.org ) if
78+ you editor supports it.
79+
7680### Configuration
7781
7882Filters are expected to be readily usable by a wide range of
@@ -83,6 +87,23 @@ There are two main methods to configure a filter: environment
8387variables and special metadata values. The ` diagram-generator `
8488filter supports both and can serve as a good reference.
8589
90+ Tests
91+ -----
92+
93+ We currently test filters under two aspects on different CI
94+ systems:
95+
96+ - * Travis CI* : filters are tested against the latest pandoc
97+ version as available from pandoc's download page. The build is
98+ configured via ` .travis.yml ` .
99+ - * Circle CI* : tests are run in the latest pandoc/ubuntu Docker
100+ image. The config is in ` .circleci/config.yml ` .
101+
102+ Both systems contain all software necessary to run the tests. Some
103+ filters require additional software to be installed. Please make
104+ sure that all requirements are satisfied in both build
105+ environments and that the builds finish successfully.
106+
86107Commits
87108-------
88109
@@ -91,6 +112,12 @@ atomic, self-contained, and add a brief but clear commit message.
91112This [ guide] ( https://chris.beams.io/posts/git-commit/ ) by Chris
92113Beams is a good resource if you'd like to learn more.
93114
115+ However, don't fret over this too much. You can also just
116+ accumulate commits without much thought for this rule. We can
117+ squash all commits in a PR into a single commit upon merging. But
118+ we still appreciate it if we don't have to rewrite the commit
119+ message.
120+
94121
95122[ issue tracker ] : https://github.com/pandoc/lua-filters/issues
96123[ Lua style guide ] : https://github.com/Olivine-Labs/lua-style-guide
0 commit comments