Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Ignore compiled and autoloads Emacs-Lisp files #3

Merged
merged 1 commit into from Jun 8, 2022

Conversation

kaushalmodi
Copy link
Contributor

Hello,

I don't know if you would accept patches at GitHub PRs too. So I thought of trying that.

[I do have my copyrights assigned to FSF.]

@protesilaos protesilaos merged commit 91f4780 into protesilaos:main Jun 8, 2022
@protesilaos
Copy link
Owner

Merged. Thank you!

@kaushalmodi
Copy link
Contributor Author

Meta: I like to follow the Conventional Commits format when writing commit messages. Let me know if you don't prefer that.

Main advantage is that by glancing the first word, people have a quick idea about what this commit category is. And also, auto changelog generation becomes much easier.

@kaushalmodi kaushalmodi deleted the add-gitignore branch June 8, 2022 16:38
@protesilaos
Copy link
Owner

I like it, though I have not used it before. Will give it a try.

@kaushalmodi
Copy link
Contributor Author

I like it because I don't need to remember to write CHANGELOGs :)

@protesilaos
Copy link
Owner

Looks nice and is informative.

That makes things easier. Whereas my change logs are verbose.

My concerns are:

  1. It links to commits on the forge's website, which makes it a bit more
    difficult to read.

  2. How do you handle cases where you need to explain some change in
    further detail. Maybe the change spans multiple commits, or there is
    some discussion surrounding it which is not obvious in the underlying
    diff. Do you edit the generated CHANGELOG?

  3. Do you enforce Conventional Commits on contributors?

@kaushalmodi
Copy link
Contributor Author

kaushalmodi commented Jun 8, 2022

It links to commits on the forge's website, which makes it a bit more difficult to read.

I see a forge as the most accessible way to view changelogs (for most users) as their primary way to access my project will be a forge and not through a local cloned git repo. The way I see it is that a user clicks on a Issue or PR hyperlinks and get further details about the commit from there.

How do you handle cases where you need to explain some change in further detail.

If it's a single commit with verbose details, the CHANGELOG links to that commit where the user can read the entire commit log. I truncate the commit log in the CHANGELOG for brevity (the truncation char count is derived empirically).

Maybe the change spans multiple commits, or there is some discussion surrounding it which is not obvious in the underlying diff.

In those case, I link the GitHub Issue or PR where the user can learn more details.

Do you edit the generated CHANGELOG?

No.

Do you enforce Conventional Commits on contributors?

I haven't had to face that problem as my project doesn't receive many PRs. But yes, if you expect a lot of external contributions, and also plan to do auto CHANGELOG generation, you'll need to document the commit writing rules and enforce them (kind of how the commit log style is enforced in Emacs).

The good thing is that I have seen quite a bit of awareness about Conventional Commits in many projects. So this concept might not be alien to many of the contributors.

@protesilaos
Copy link
Owner

I see. Thank you for the explanation!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants