diff --git a/.gitignore b/.gitignore index 00cbbdf53f6c487c8392d936ce7225824c11446e..14d62b125576b8c6756cda20461cf77f3ebc11f8 100644 --- a/.gitignore +++ b/.gitignore @@ -57,3 +57,5 @@ typings/ # dotenv environment variables file .env +# npm package-lock.json +package-lock.json diff --git a/.textlintrc b/.textlintrc new file mode 100644 index 0000000000000000000000000000000000000000..68796b80a59b71095b2214031e2318ccaf96328b --- /dev/null +++ b/.textlintrc @@ -0,0 +1,14 @@ + +plugins: + - asciidoctor + +rules: + apostrophe: true + common-misspellings: true + diacritics: true + en-capitalization: true + en-max-word-count: true + stop-words: true + write-good: + passive: false + \ No newline at end of file diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..0fbac826ca49f5bbaf51efbf1884ed5ff2be3760 --- /dev/null +++ b/README.adoc @@ -0,0 +1,62 @@ += The Eclipse Development Process Repository +Eclipse Management Organization <emo@eclipse.org> +:hide-uri-scheme: + +Welcome to the Eclipse Development Process Repository. +This repository is a document generation hub and provides an infrastructure for hosting, extending and generating documents of the Eclipse Development Process. +Our link:eclipse_development_process.adoc[Eclipse Development Process] is the go-to source of truth for Eclipse committers. +Please make yourself familar and don’t hesitate to give feedback. + +By maintaining our link:eclipse_development_process.adoc[Eclipse Development Process document] in this repository, we are embracing a transparent and open culture about our process. +Watch link:https://bit.ly/pull-request-your-culture[Changing the Laws of Engineering with GitHub Pull Requests] for additional background on why we’ve choosen this approach. +Please open issues or pull requests if you’d like to see our process evolove. + + +== Feedback & Contact + +We’d like to hear your feedback. +It matters to us! + +Please submit feedback using one of the following ways: + +* Submit an issue, or +* Submit a pull request (please read <<Contributing>> below). + + +== Contributing + +This directory contains the source for the[Eclipse Development Process](eclipse_development_process.adoc) in AsciiDoc format, the build script, and generated output. +The build script is configured to generate output for a specific version of the document and running the build (`npm run build`) may overwrite any existing document. + +The output files (eg., `*.html`) may be live documents that may be included by other documents found in the repository and also externally, so take care with what you commit. + +=== Installing NPM +NPM is required for generating the output files. +Please have a look at link:https://www.npmjs.com/get-npm[Get npm!] + +=== Installing Asciidoctor +Please allow NPM to install all dependencies by running `npm run install`. + +=== AsciiDoc Syntax +Please refere to link:http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc Syntax Quick Reference]. + +=== Making changes +Follow link:https://asciidoctor.org/docs/asciidoc-recommended-practices/[AsciiDoc Recommended Practices] when making changes. +In particular, the one sentence per line recommendation is important to us. +This makes it much easier to view the diffs in git. + +As a sanity check, `npm run lint` should be run before committing. +It should be run automatically because npm install should setup Git a pre-coomit hook automatically. + +TIP: Sometimes, it isn’t possible to fix all lint issue, e.g., because you’d like to try out something for testing or discussion. +In that case, you can use `git commit --no-verify` to temporarily bypass the check. + +=== Update Process +Please submit pull requests for any proposals/semantic changes/enhancements. +We’ll use pull requests for discussing them. + +Requirements, ideas and todos should be captured in issues and should be referenced in pull requests addressing them. + +A note for committers: spelling, grammatical as well as cosmetic corrections don’t require a pull request *except* for the official [Eclipse Development Process document](eclipse_development_process.adoc). + +_Any change to `eclipse_development_process.adoc` requires a pull request and full EMO review and approval before merge._ diff --git a/README.md b/README.md deleted file mode 100644 index da281a8f010c145d66f0f1d2bc3a96ab4b82c4d1..0000000000000000000000000000000000000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# development-process -The Eclipse Development Process diff --git a/package.json b/package.json new file mode 100644 index 0000000000000000000000000000000000000000..d12ddf4635293968d0c2e4f7a9b7059a181e5442 --- /dev/null +++ b/package.json @@ -0,0 +1,41 @@ +{ + "name": "eclipse-development-process", + "version": "1.0.0", + "description": "Build project for generating documents of the Eclipse Development Process", + "dependencies": {}, + "devDependencies": { + "asciidoctor-cli": "^1.5.5-beta.3", + "husky": "^0.14.3", + "textlint": "^10.2.1", + "textlint-plugin-asciidoctor": "^1.0.2", + "textlint-rule-apostrophe": "^1.0.0", + "textlint-rule-common-misspellings": "^1.0.1", + "textlint-rule-diacritics": "0.0.2", + "textlint-rule-en-capitalization": "^2.0.1", + "textlint-rule-en-max-word-count": "^1.0.1", + "textlint-rule-stop-words": "^1.0.3", + "textlint-rule-write-good": "^1.6.2" + }, + "scripts": { + "lint": "textlint -f pretty-error *.adoc", + "lint:fix": "textlint --fix *.adoc", + "build": "asciidoctorjs --help", + "precommit": "npm run lint" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/eclipse-architecture/eclipse-development-process.git" + }, + "keywords": [ + "eclipse", + "development", + "process", + "edp" + ], + "author": "Eclipse Management Organization (EMO)", + "license": "EPL-2.0", + "bugs": { + "url": "https://github.com/eclipse-architecture/eclipse-development-process/issues" + }, + "homepage": "https://github.com/eclipse-architecture/eclipse-development-process#readme" +}