diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e69de29 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..74c6942 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,76 @@ +# Contributing to the Lua Users Foundation + +This document serves as contribution guidelines and the points listed should be +followed for contributions to the foundation. + +Contributions are expected to follow the [code of conduct](CODE_OF_CONDUCT.md). + +## Commit Guidelines + +As is somewhat standard practice, the following should be observed: + +- The usage of Markdown-formatted lists is allowed +- The header line should be no more than 60 characters +- Commit headers should start with an imperative verb, to act as a description +of what applying the commit would do: "If applied, this commit will..." +- Paragraphs should be broken with an empty line between +- Further lines after the header should be no more than 72 characters +- Further lines, if required, should contain detailed information on: + 1. Implications of the changes in the commit + 2. Reasons the changes are required + +Commits relating to one file should follow these guidelines: + +- The header line should contain the filename and a short description of what +applying the patch will do, in the format of "If applied, this commit will..." +- The second line should be blank + +Example commit message: + +```markdown +CONTRIBUTING.md: Establish guidelines for new commits + +Implications of Changes: + +- Could possibly make it harder for outsiders to contribute +- Could create bloatware in the repository data + +Reasons for Changes: + +- Creates a structure which can be used to avoid excessive comments + during the review process +``` + +Commits relating to multiple files should follow these guidelines: + +- The header line should contain a short description of what applying the patch +will do, in the format of "If applied, this commit will..." +- The second line should be blank +- The third line should begin a list of changed files, with a header along the +lines of "Changed Files:" + +Example commit message: + +```markdown +Apply changes to files as per guidelines + +Changed Files: +- README.md +- CONTRIBUTING.md + +Reasons for Changes: +- This is an example message, but anyways: The guidelines changed, so this + commit adapts the documents to follow the new guidelines as of 2018-03-14. +``` + + +## Document Design Guidelines + +Contributions to documents for the repository should follow these guidelines: + +- Lines should be no more than 80 characters +- Documents should be written using standard Markdown (try to avoid using +GitHub flavoring) +- Documents should use relative URLs when linking to other documents +- Links should use the format of putting a link at the bottom of the page if a +line breaks 80 characters diff --git a/README.md b/README.md index 0d25bf5..ef7f8be 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,29 @@ # Lua Users Foundation -This is the main repository where the Lua community can collaborate in order to organise the foundation. +This is the main repository where the Lua community can collaborate in order to +organise the foundation. # What is the Lua Users Foundation -The Lua Users Foundation is an association of individuals in a modular umbrella structure with the mission of supporting and promoting the Lua programming language, its community and ecosystems. Please take check the current draft of our Manifesto for more details, or even collaborate to its definition. You can see our work in progress in the [Pull Requests](https://github.com/lua-users-foundation/foundation/pulls) of this repository. +The Lua Users Foundation is an association of individuals in a modular umbrella +structure with the mission of supporting and promoting the Lua programming +language, its community and ecosystems. Please take check the current draft of +our Manifesto for more details, or even collaborate to its definition. You can +see our work in progress in the [Pull Requests][pull-requests] of this +repository. # Who we are -The list of people involved with the foundation can be seen [here](https://github.com/orgs/lua-users-foundation/people). This list is currently being updated and also in the meantime there is a [discussion](https://github.com/lua-users-foundation/foundation/issues/1) on how to define membership of the foundation. +The list of people involved with the foundation can be seen [here][gh-org]. +This list is currently being updated and also in the meantime there is a +[discussion][issue-1] on how to define membership of the foundation. # Join us -Join us and collaborate in this initiave. The work will be conducted in this repository and we are also chatting about it at Slack. Click here to join our [Slack Channel](https://join.slack.com/t/lua-users-foundation/shared_invite/enQtMzMwMDQ2MTcwNzU4LTg1YmU1ZDg0ZGY0MGY2OTdhZjQ0YzZmNjAzNzdhMTZjNTdkMDNkOWNmZDlkMmZiNWQ0M2ZlNWQ4MGI5YjUxNzQ) +Join us and collaborate in this initiave. The work will be conducted in this +repository and we are also chatting about it at Slack. Click here to join our +[Slack Channel][slack-channel]. + +[pull-requests]: https://github.com/lua-users-foundation/foundation/pulls +[gh-org]: https://github.com/orgs/lua-users-foundation/people +[issue-1]: https://github.com/lua-users-foundation/foundation/issues/1 +[slack-channel]: https://join.slack.com/t/lua-users-foundation/shared_invite/enQtMzMwMDQ2MTcwNzU4LTg1YmU1ZDg0ZGY0MGY2OTdhZjQ0YzZmNjAzNzdhMTZjNTdkMDNkOWNmZDlkMmZiNWQ0M2ZlNWQ4MGI5YjUxNzQ