github-starred/barrier

Fork 0

mirror of https://github.com/debauchee/barrier.git synced 2026-05-15 14:16:02 -06:00

[GH-ISSUE #716] Guidelines for code #564

New issue

Open

opened 2026-05-05 06:41:16 -06:00 by gitea-mirror · 8 comments

gitea-mirror commented

2026-05-05 06:41:16 -06:00

Owner

Originally created by @shymega on GitHub (May 30, 2020).
Original GitHub issue: https://github.com/debauchee/barrier/issues/716

Originally assigned to: @shymega on GitHub.

We should make a list of guidelines for code contributions.

For example, with a review comment in #703, it is pointed out about tabs and spaces in the contribution. We could use EditorConfig to assist with these guidelines to an extent, depending on the editor used by contributor(s).

I'm assigning this issue to myself to create a configuration file if the suggestion gets a positive reaction.

Originally created by @shymega on GitHub (May 30, 2020). Original GitHub issue: https://github.com/debauchee/barrier/issues/716 Originally assigned to: @shymega on GitHub. We should make a list of guidelines for code contributions. For example, with a review comment in #703, it is pointed out about tabs and spaces in the contribution. We could use [EditorConfig](https://editorconfig.org/) to assist with these guidelines to an extent, depending on the editor used by contributor(s). I'm assigning this issue to myself to create a configuration file if the suggestion gets a positive reaction.

gitea-mirror added the

enhancement

label 2026-05-05 06:41:16 -06:00

gitea-mirror commented

2026-05-05 06:41:18 -06:00

Author

Owner

@p12tic commented on GitHub (May 30, 2020):

I think it's enough if we had the guidelines themselves somewhere. People can then configure their editors according to them. For example, EditorConfig does not support my editor of choice, I guess there will more people with similar issues :)

@p12tic commented on GitHub (May 30, 2020): I think it's enough if we had the guidelines themselves somewhere. People can then configure their editors according to them. For example, EditorConfig does not support my editor of choice, I guess there will more people with similar issues :)

gitea-mirror commented

2026-05-05 06:41:20 -06:00

Author

Owner

@shymega commented on GitHub (May 30, 2020):

Sure, we can have the guidelines on the wiki/repo (or both), but there's nothing wrong with having EditorConfig available as well. Just because it doesn't support X editor doesn't make it inherently unnecessary. What editor do you use incidentally?

@shymega commented on GitHub (May 30, 2020): Sure, we can have the guidelines on the wiki/repo (or both), but there's nothing wrong with having EditorConfig available as well. Just because it doesn't support X editor doesn't make it inherently unnecessary. What editor do you use incidentally?

gitea-mirror commented

2026-05-05 06:41:22 -06:00

Author

Owner

@p12tic commented on GitHub (May 30, 2020):

Agreed. I use QtCreator.

@p12tic commented on GitHub (May 30, 2020): Agreed. I use QtCreator.

gitea-mirror commented

2026-05-05 06:41:24 -06:00

Author

Owner

@shymega commented on GitHub (May 30, 2020):

Ah, I've never used that. I use VS Code. I'll work on a basic EditorConfig for now, and create a document in the repo's root. Thoughts on creating a Wiki page for it? We could do with a Contributing page, so perhaps integrate into that?

@shymega commented on GitHub (May 30, 2020): Ah, I've never used that. I use VS Code. I'll work on a basic EditorConfig for now, and create a document in the repo's root. Thoughts on creating a Wiki page for it? We could do with a Contributing page, so perhaps integrate into that?

gitea-mirror commented

2026-05-05 06:41:26 -06:00

Author

Owner

@shymega commented on GitHub (May 31, 2020):

@p12tic Is 4 spaces alright? EditorConfig also allows specifying of line endings.. so we could stick to CR or CRLF.

@shymega commented on GitHub (May 31, 2020): @p12tic Is 4 spaces alright? EditorConfig also allows specifying of line endings.. so we could stick to CR or CRLF.

gitea-mirror commented

2026-05-05 06:41:27 -06:00

Author

Owner

@p12tic commented on GitHub (May 31, 2020):

Yes, 4 spaces is good. For line endings we should use LF as anything other will introduce problems. Git recomments using LF for cross-platform projects.

@p12tic commented on GitHub (May 31, 2020): Yes, 4 spaces is good. For line endings we should use LF as anything other will introduce problems. Git recomments using LF for cross-platform projects.

gitea-mirror commented

2026-05-05 06:41:29 -06:00

Author

Owner

@github-actions[bot] commented on GitHub (Sep 20, 2020):

This issue has been automatically marked as stale due to inactivity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions[bot] commented on GitHub (Sep 20, 2020): This issue has been automatically marked as stale due to inactivity. It will be closed if no further activity occurs. Thank you for your contributions.

gitea-mirror commented

2026-05-05 06:41:30 -06:00

Author

Owner

@shymega commented on GitHub (Sep 20, 2020):

EditorConfig committed. Wiki page is the next step.

@shymega commented on GitHub (Sep 20, 2020): EditorConfig committed. Wiki page is the next step.