Proposal: Support for commit comments

Amir_Michail1 · December 21, 2015, 7:07pm

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

Douglas_Gregor · December 21, 2015, 10:38pm

This has nothing to do with Swift.

- Doug

···

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

Amir_Michail1 · December 21, 2015, 10:53pm

Aren’t comments part of Swift?

···

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

This has nothing to do with Swift.

- Doug

Douglas_Gregor · December 21, 2015, 10:54pm

*Commit messages* aren’t part of Swift.

- Doug

···

On Dec 21, 2015, at 2:53 PM, Amir Michail <amichail@gmail.com> wrote:

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

This has nothing to do with Swift.

- Doug

Aren’t comments part of Swift?

gparker42 · December 21, 2015, 10:56pm

Comments are, but commits are not. We don't have any way to force source control systems like git or svn to scan our files for special comments.

···

On Dec 21, 2015, at 2:53 PM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

This has nothing to do with Swift.

Aren’t comments part of Swift?

--
Greg Parker gparker@apple.com Runtime Wrangler

Amir_Michail1 · December 21, 2015, 11:00pm

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

This has nothing to do with Swift.

Aren’t comments part of Swift?

Comments are, but commits are not. We don't have any way to force source control systems like git or svn to scan our files for special comments.

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

···

On Dec 21, 2015, at 5:56 PM, Greg Parker <gparker@apple.com> wrote:

On Dec 21, 2015, at 2:53 PM, Amir Michail via swift-evolution <swift-evolution@swift.org <mailto:swift-evolution@swift.org>> wrote:

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

--
Greg Parker gparker@apple.com <mailto:gparker@apple.com> Runtime Wrangler

Brent_Royal-Gordon · December 21, 2015, 11:03pm

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

···

--
Brent Royal-Gordon
Architechies

karl_catigbe · December 21, 2015, 11:01pm

Pre commit hook. What you want is a pre commit hook.

···

On Monday, December 21, 2015, Amir Michail via swift-evolution < swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 5:56 PM, Greg Parker <gparker@apple.com > <javascript:_e(%7B%7D,'cvml','gparker@apple.com');>> wrote:

On Dec 21, 2015, at 2:53 PM, Amir Michail via swift-evolution < > swift-evolution@swift.org > <javascript:_e(%7B%7D,'cvml','swift-evolution@swift.org');>> wrote:

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com > <javascript:_e(%7B%7D,'cvml','dgregor@apple.com');>> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution < > swift-evolution@swift.org > <javascript:_e(%7B%7D,'cvml','swift-evolution@swift.org');>> wrote:

Upon a commit, these comments would be automatically removed from the
source and combined into a single commit comment.

In this way, you would not need to remember what changes you are
committing in order to make up a commit comment. You just comment the code
as you make the changes.

A special syntax would be used for commit comments so they are never
confused with normal comments.

Note also that in the case of multiple changes being committed at once,
these commit comments would give a more accurate mapping of the individual
comments to the code changes they refer to.

This has nothing to do with Swift.

Aren’t comments part of Swift?

Comments are, but commits are not. We don't have any way to force source
control systems like git or svn to scan our files for special comments.

If it is part of the language standard and is supported by Xcode, then
many source control systems/IDEs will support it also as it gives them a
competitive advantage.

--
Greg Parker gparker@apple.com
<javascript:_e(%7B%7D,'cvml','gparker@apple.com');> Runtime Wrangler

--
"Those who would give up liberty for the sake of security deserve neither
liberty nor security."
-Benjamin Franklin

Amir_Michail1 · December 21, 2015, 11:04pm

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

It doesn’t have to be. But if Xcode supports it, then more people will know about this language feature.

···

On Dec 21, 2015, at 6:03 PM, Brent Royal-Gordon <brent@architechies.com> wrote:

--
Brent Royal-Gordon
Architechies

owensd · December 21, 2015, 11:18pm

What you are talking about are source control hooks. They don’t belong in a language as a language is completely agnostic of a source control system, assuming on is even used.

···

On Dec 21, 2015, at 3:04 PM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 6:03 PM, Brent Royal-Gordon <brent@architechies.com> wrote:

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

It doesn’t have to be. But if Xcode supports it, then more people will know about this language feature.

--
Brent Royal-Gordon
Architechies

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution

Amir_Michail1 · December 21, 2015, 11:20pm

What you are talking about are source control hooks. They don’t belong in a language as a language is completely agnostic of a source control system, assuming on is even used.

I thought Apple was all about integration to create seamless experiences?

···

On Dec 21, 2015, at 6:18 PM, David Owens II <david@owensd.io> wrote:

On Dec 21, 2015, at 3:04 PM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 6:03 PM, Brent Royal-Gordon <brent@architechies.com> wrote:

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

It doesn’t have to be. But if Xcode supports it, then more people will know about this language feature.

--
Brent Royal-Gordon
Architechies

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution

Craig_Cruden · December 21, 2015, 11:27pm

Amir,

You might want to read the scope of swift-evolution:

github.com

possen/swift-evolution/blob/master/process.md

# Swift Evolution Process

Swift is a powerful and intuitive programming language that is designed to make writing and maintaining correct programs easier. Swift is growing and evolving, guided by a community-driven process referred to as the Swift evolution process. This document outlines the Swift evolution process and how a feature grows from a rough idea into something that can improve the Swift development experience for millions of programmers.

## Scope

The Swift evolution process covers all changes to the Swift language and the public interface of the Swift standard library, including new language features and APIs (no matter how small), changes to existing language features or APIs, removal of existing features, and so on. Smaller changes, such as bug fixes, optimizations, or diagnostic improvements can be contributed via the normal contribution process; see [Contributing to Swift](https://swift.org/community/#contributing).

## Goals

The Swift evolution process aims to leverage the collective ideas, insights, and experience of the Swift community to improve the Swift development experience. Its two primary goals are:

* Engage the wider Swift community in the ongoing evolution of Swift, and
* Maintain the vision and conceptual coherence of Swift.

There is a natural tension between these two goals. Open evolution processes are, by nature, chaotic. Yet, maintaining a coherent vision for something as complicated as a programming language requires some level of coordination. The Swift evolution process aims to strike a balance that best serves the Swift community as a whole.

## Participation

Everyone is welcome to propose, discuss, and review ideas to improve

This file has been truncated. show original

···

On 2015-12-22, at 6:20:08, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 6:18 PM, David Owens II <david@owensd.io> wrote:

What you are talking about are source control hooks. They don’t belong in a language as a language is completely agnostic of a source control system, assuming on is even used.

I thought Apple was all about integration to create seamless experiences?

On Dec 21, 2015, at 3:04 PM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 6:03 PM, Brent Royal-Gordon <brent@architechies.com> wrote:

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

It doesn’t have to be. But if Xcode supports it, then more people will know about this language feature.

--
Brent Royal-Gordon
Architechies

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution