diff --git a/.gitignore b/.gitignore index cc5b71eed19a117ae53b0b4bd84fb3b4d87df766..cdd8aa09bca4d43b5b61b5d397c147308a877a68 100644 --- a/.gitignore +++ b/.gitignore @@ -1,65 +1,3 @@ -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# Bower dependency directory (https://bower.io/) -bower_components - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (http://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules/ -jspm_packages/ - -# Typescript v1 declaration files -typings/ - -# Optional npm cache directory -.npm - -# Optional eslint cache -.eslintcache - -# Optional REPL history -.node_repl_history - -# Output of 'npm pack' -*.tgz - -# Yarn Integrity file -.yarn-integrity - -# dotenv environment variables file -.env - -# npm package-lock.json -package-lock.json - -# for now ignore any generated html +.asciidoctor .html /target/ diff --git a/.project b/.project index 50de97a0b2df02a824a7ca69bcfe59dee4d37ef2..f00250b4187769c90762fca12aff0702a97caf64 100644 --- a/.project +++ b/.project @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <projectDescription> - <name>eclipse-development-process</name> + <name>Eclipse Foundation Development Process</name> <comment></comment> <projects> </projects> diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index a31dbf6fd7a9de2c93c31bed60613b4422622cbf..0000000000000000000000000000000000000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - // See http://go.microsoft.com/fwlink/?LinkId=827846 - // for the documentation about the extensions.json format - "recommendations": [ - // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp - "christian-kohler.npm-intellisense", - "christian-kohler.path-intellisense", - "eg2.vscode-npm-script", - "DavidAnson.vscode-markdownlint", - "EditorConfig.EditorConfig", - "formulahendry.auto-close-tag", - "joaompinto.asciidoctor-vscode", - "eamodio.gitlens", - "waderyan.gitblame", - "donjayamanne.githistory" - ] -} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc119069302f080f43d375c5a798704e1cd79eb3..6c2240190d1d78f6598aa3234348267aa64355a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,45 +1,30 @@ # Eclipse Development Process Community Contributing Guide 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 [Get npm!](https://www.npmjs.com/get-npm) - -## Installing Asciidoctor - -Please allow NPM to install all dependencies by running `npm install`. - -## AsciiDoc Syntax +## Update Process -Please refere to [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/). +Please submit pull requests for any changes. We’ll use pull requests for discussing them. -## Making changes +New requirements, ideas and significant changed should be captured in issues. Discussion summary/results must be documented (and referenced) in pull requests and issues. -Follow [AsciiDoc Recommended Practices](https://asciidoctor.org/docs/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. +**No pull request** can be merged **without being reviewed**. -As a sanity check, `npm test` should be run before committing. -It should be run automatically because `npm install` will setup a Git pre-coomit hook. +### Eclipse Contributor Agreement -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. +Before your contribution can be accepted by the project team contributors must +electronically sign the Eclipse Contributor Agreement (ECA). -## Update Process +* http://www.eclipse.org/legal/ECA.php -Please submit pull requests for any changes. -We’ll use pull requests for discussing them. +Commits that are provided by non-committers must have a Signed-off-by field in +the footer indicating that the author is aware of the terms by which the +contribution has been provided to the project. The non-committer must +additionally have an Eclipse Foundation account and must have a signed Eclipse +Contributor Agreement (ECA) on file. -New requirements, ideas and significant changed should be captured in issues. -Larger items should be brought to the Architecture Council mailing list for discussion. -Discussion summary/results must be documented (and referenced) in pull requests and issues. - -**No pull request** can be merged **without being reviewed**. +For more information, please see the Eclipse Committer Handbook: +https://www.eclipse.org/projects/handbook/#resources-commit ### Sign-off Process diff --git a/README.adoc b/README.adoc index 902e1bb824d8d2a6da87faf76729aa1ed09c6c7f..112b0f4e6d731a5113fffd4e8d16af062f56c7ba 100644 --- a/README.adoc +++ b/README.adoc @@ -2,15 +2,18 @@ Eclipse Management Organization <emo@eclipse.org> :hide-uri-scheme: -Welcome to the Eclipse Development Process Repository. +Welcome to the Eclipse Foundation 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. +Please open issues or pull requests if you’d like to see our process evolove. == Feedback & Contact @@ -22,13 +25,8 @@ Please submit feedback using one of the following ways: * Submit an issue, or * Submit a pull request (please read <<Contributing>> below). - == Contributing IMPORTANT: Any changes to `eclipse_development_process.adoc` and its accompanying documents (even trivial one, eg. correcting typos) require a pull request and full EMO review and approval before merge. -. Fork/clone the repository -. Create a new branch based of `develop` -. Run `npm install` -. Read the link:CONTRIBUTING.md[Contribution Guide] - +Please read the link:CONTRIBUTING.md[Contribution Guide]. diff --git a/package.json b/package.json deleted file mode 100644 index 8cc9e6f870a95bf4175c0b90ef10fc61d52b5edb..0000000000000000000000000000000000000000 --- a/package.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "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 README.adoc *.md", - "lint:edp": "textlint -f pretty-error eclipse_*.adoc", - "lint:fix": "textlint --fix README.adoc *.md", - "build": "asciidoctorjs eclipse_development_process.adoc", - "precommit": "npm test", - "test": "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" -}