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

Add manifesto document #3

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add manifesto document #3

wants to merge 3 commits into from

Conversation

Etiene
Copy link
Member

@Etiene Etiene commented Mar 14, 2018

Adds first public draft of the foundation's manifesto

@@ -0,0 +1,28 @@
# The Lua Users Foundation Manifesto

The Lua Users Foundation (the Foundation) is an association of individuals in a modular umbrella structure consisted of several workgroups, detailed in the Lua Users Foundation Constitution.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The constitution document will be drafted in the future.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NB: PR comments are the same thing as in-document comments --- as they become much less visible once PR is merged

* To support and foster critical projects such as Lua libraries (modules) and frameworks ecosystems.
* To support and foster the Lua community.
* To encourage wider adoption of Lua programming language in the world.
* To be a lasting organisation generating positive impact to those writing software in Lua.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

organiZation (I suggest we adopt US English)

@@ -0,0 +1,28 @@
# The Lua Users Foundation Manifesto
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a note that this document is a draft and not yet normative

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't add that because the fact that it is an unmerged PR is already indicating that it is a draft

Copy link
Member

@agladysh agladysh Mar 14, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to add and merge (after review). Unmerged PRs are less visible (and are harder to create a PR against).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please elaborate the question.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A merged PR is not a PR anymore 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still do not understand.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I understood what you mean

Etiene, please add "Draft" to the document, then it'll be merged. After that, others will make PRs with changes related to this document

@@ -0,0 +1,28 @@
# The Lua Users Foundation Manifesto

The Lua Users Foundation (the Foundation) is an association of individuals in a modular umbrella structure consisted of several workgroups, detailed in the Lua Users Foundation Constitution.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/consisted/consisting/

# The Lua Users Foundation Manifesto

The Lua Users Foundation (the Foundation) is an association of individuals in a modular umbrella structure consisted of several workgroups, detailed in the Lua Users Foundation Constitution.
The Foundation formal decision-making process is governed by the Lua Users Foundation Constitution, according to the Foundation Goals and Values, towards our Mission.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Foundation/Foundation's/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which one?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Foundation formal decision-making process

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh thanks, good catch

@agladysh
Copy link
Member

Unless we want to squash the pull request history, I suggest to more carefully write commit messages, so the public will be able to get a better idea what happened and if they must to pay careful attention to the change. E.g. not "updated manifesto", but rather "fixed typos in manifesto".

@Etiene
Copy link
Member Author

Etiene commented Mar 14, 2018

@agladysh I was thinking squashing it, which is why I wasn't too careful about that

@agladysh
Copy link
Member

agladysh commented Mar 14, 2018

@Etiene As long as we wouldn't lose the discussion here by squashing, I have no problem with that. (I keep confusing GitLab and GitHub behavior in that regard.)


* The Lua programming language is developed by the Lua Team and defined by the Lua Programming Manual. Furthermore:
* The Lua programming language is small, fast, easy to learn and use.
* The Lua programming language philosophy is less is more.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would write:

The Lua programming language philosophy is: "Less is more".

Also I am not sure if this is not controversial...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like your phrasing. It probably is somewhat controversial, yes. But it is the original philosophy of Lua and I think we should strive not to deviate from that.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the philosophy of lua is better described as "mechanism, not policy"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the philosophy of lua is better described as "mechanism, not policy"

Finally found a good citation from the lua team. https://www.lua.org/wshop13/Ierusalimschy.pdf see 2nd last page.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks!

## The Values

* The Lua programming language is developed by the Lua Team and defined by the Lua Programming Manual. Furthermore:
* The Lua programming language is small, fast, easy to learn and use.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this line and the previous one make sense here. They are facts not values, and concern the Lua language not the Foundation.

Copy link
Member Author

@Etiene Etiene Mar 14, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is there to state our position in the "is LuaJIT Lua?" controversy

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, it makes sense.

## The Goals

* To aid the Lua Team and the Lua programming language implementers.
* To support and foster critical projects such as Lua libraries (modules) and frameworks ecosystems.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/frameworks ecosystems/framework ecosystems/

... I think. :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think frameworks ecosystems is the correct! :)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think catwell is correct here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

framework ecosystems or ecosystems of frameworks (less wieldy and with the same meaning).

@RyanSquared
Copy link

Suggestion to have a contribution guideline for documentation, to keep lines around 80 characters? This would improve how GitHub displays reviews, breaking paragraphs into separate distinct lines that can be reviewed, and can properly display everything on-screen - we can always scroll down, but we can't always scroll right.

@Etiene
Copy link
Member Author

Etiene commented Mar 14, 2018

@RyanSquared sure, I can cap this document at 80 characters per line. Would you like to make a PR for a contribution guideline file that mentions this?

@RyanSquared
Copy link

RyanSquared commented Mar 14, 2018

Sure, that'd be helpful, thanks. 👍

I'll go draft a PR for a contributing guidelines in a bit.

@agladysh
Copy link
Member

@Etiene Is anything blocking on finishing this PR and merging it to master?


## The Values

* The Lua programming language is developed by the Lua Team and defined by the Lua Programming Manual. Furthermore:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should clarify on what the language is. Is it the language as described in the manual? Or is it the reference implementation?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a difficult question, which will block the development of the manifesto. I say that one of the goals of the LUF is to make this point officially clarified by the Lua Team

There were many discussions on that point with Roberto on previous Lua in Moscow. Please refer to: https://www.youtube.com/watch?v=wdRGOE1N-FA&list=PLTHTttj90_1mdhrKc-H5apZWoVIXmkhcN (in English), especially second and third talks.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Etiene's comment at #3 (comment) implies that we've already selected an answer to this question.
As far as I know, LuaJIT is compliant to the lua 5.1 manual.
Which then implies that "the lua language" in this paragraph is intended to be the reference implementation; not what is described in the manual.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not follow, sorry. This item clearly states that the Lua language is whatever that is developed (as a language) by the Lua Team and defined by the Manual. No?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this is a difficult question. I would rather make a decision, even if it is a political decision, with the understanding that we can update this manifesto at a later point.

## The Goals

* To aid the Lua Team and the Lua programming language implementers.
* To support and foster critical projects such as Lua libraries (modules) and frameworks ecosystems.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think catwell is correct here

* The Lua programming language is developed by the Lua Team and defined by the Lua Programming Manual. Furthermore:
* The Lua programming language is small, fast, easy to learn and use.
* The Lua programming language philosophy is less is more.
* The Lua ecosystem is diverse, it includes many libraries, frameworks, implementations, dialects and related languages.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The Lua ecosystem is diverse: it includes many libraries, frameworks, implementations, dialects and related languages."
Note the ":"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe, yes

* The Lua community is inclusive. We welcome and encourage participation by everyone. We are committed to foster a diverse community with respect of personal characteristics such as, but not limited to, gender identity or expression, sexual orientation, ethnicity, age, religion, disability, class, geographic location, background and experience.
* Lua and related technologies should have wider adoption in the world.
* The Lua Users Foundation is a transparent and not for profit endeavour.
* The Lua Users Foundation values simplicity and accessibility (easy to learn and use) in our work.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it should be moved closer to "less is more" point. Or maybe they should be merged together somehow.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're welcome to create a pull request with suggested edits.


## The Goals

* To aid the Lua Team and the Lua programming language implementers.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In "The Mission" section you didn't start sentences with "To". Maybe here we don't need it as well? (and in the next bullet points too)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

## The Goals

* To aid the Lua Team and the Lua programming language implementers.
* To support and foster critical projects such as Lua libraries (modules) and frameworks ecosystems.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest to replace "critical" to "important". "Critical" is something that people can't live without, and you can survive without Lua libs/frameworks for a long time. :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't change the ambiguity. One need to define what is "critical" or "important" somewhere in the documents to work around that problem. Also, there are different degrees of critical (mission critical, life critical etc.), so the implication is less severe here, IMO.

* To support and foster critical projects such as Lua libraries (modules) and frameworks ecosystems.
* To support and foster the Lua community.
* To encourage wider adoption of Lua programming language in the world.
* To be a lasting organization generating positive impact to those writing software in Lua.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/to/on

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed

@agladysh
Copy link
Member

agladysh commented Apr 2, 2018

@Etiene Please, let's go to merge

@Etiene
Copy link
Member Author

Etiene commented Apr 4, 2018

@agladysh updated! please re-review

Lua Programming Manual. Furthermore:
* The Lua programming language is small, fast, easy to learn and use.
* The Lua programming language philosophy is: "Mechanisms instead of
policies".

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

formatting nit: there are two spaces before the quote.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1


## The Goals

* Aid the Lua Team and the Lua programming language implementers.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the 2nd 'the'?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure, let someone with a better sense of English comment


* Aid the Lua Team and the Lua programming language implementers.
* Support and foster critical projects such as Lua libraries (modules) and
framework ecosystems.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove 'ecosystems'?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is an important word, I think. Let's postpone until a second revision.

* Aid the Lua Team and the Lua programming language implementers.
* Support and foster critical projects such as Lua libraries (modules) and
framework ecosystems.
* Support and foster the Lua community.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we avoid repeating "support and foster"?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please suggest how to rephrase. Let's postpone until a second revision.

@agladysh
Copy link
Member

agladysh commented Apr 6, 2018

LGTM

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

Successfully merging this pull request may close these issues.

6 participants