Commit 157646f

nsxiv157646f

etc changes related to code-style docs

* Add a "Code Style" section in CONTRIBUTING
* Move .clang-format to etc/
* Add a short comment on clang-format and editorconfig file

+21 −1

3 files changed

−Context 3+

M .editorconfig View

R .clang-format → etc/.clang-format View

M etc/CONTRIBUTING.md View

		@@ -1,4 +1,6 @@
1	1		# EditorConfig
	2	+	# See this if your editor doesn't have built-in editorconfig support:
	3	+	# https://editorconfig.org/#download
2	4
3	5		# apply to all files
4	6		[*]

		@@ -1,3 +1,6 @@
	1	+	# clang-format doesn't dictate the project's code style and can mess up a
	2	+	# couple edge cases. However it comes quite close and can be used for fixing
	3	+	# most style issues automatically on new changes via `git-clang-format`.
1	4		---
2	5
3	6		Standard: c++03

		@@ -23,7 +23,7 @@ Contribution Guideline
23	23		When contributing, make sure:
24	24
25	25		* Your contribution falls under nsxiv's scope and aim
26		−	* You follow the existing code style (see [.editorconfig](../.editorconfig))
	26	+	* You follow the existing code style (see the "Code Style" section below)
27	27		* You open the pull request from a new branch, not from master
28	28		* To avoid using force pushes, especially for bigger patches. Only use them
29	29		when there's merge conflicts.
		@@ -44,6 +44,21 @@ to work on. You can also filter the issues via label:
44	44		(Intermediate/Experienced) Issues where we require some help.
45	45
46	46
	47	+	Code Style
	48	+	----------
	49	+
	50	+	`nsxiv` mostly follows the [suckless code-style][sl], with a few exceptions.
	51	+	If your editor supports [.editorconfig](../.editorconfig) then you'll already be
	52	+	off to a good start without needing much manual intervention. Additionally we
	53	+	provide a [clang-format](./.clang-format) configuration for reference, which you
	54	+	may use via [`git-clang-format`][cf] to format the changes you've made (please
	55	+	do not run it globally on the entire code-base since clang-format gets a decent
	56	+	amount of edge cases wrong).
	57	+
	58	+	[sl]: https://suckless.org/coding_style/
	59	+	[cf]: https://clang.llvm.org/docs/ClangFormat.html#git-integration
	60	+
	61	+
47	62		Development workflow for maintainers
48	63		------------------------------------
49	64