docs: add CONTRIBUTING.md

2026-08-04 22:46:55 +00:00 · 2020-10-05 15:52:58 -07:00
parent dd45840950
commit 5c62fb63f8
1 changed files with 86 additions and 0 deletions
@@ -0,0 +1,86 @@
+# Contributing
+
+## How to Contribute
+
+### Getting Code
+
+1. Clone this repository
+
+```bash
+git clone https://github.com/microsoft/playwright-java
+cd playwright-java
+```
+
+2. Checkout and build playwright node.js package
+
+```bash
+cd driver
+npm install
+npm run build
+```
+
+### Generating API
+
+Public Java API is generated from [api.json](https://github.com/microsoft/playwright-java/blob/master/api-generator/src/main/resources/api.json) which in turn is created by [`npm run generate-api-json`](https://github.com/microsoft/playwright/blob/2df6425254232125e46347d5e8cddd71c3cecce6/package.json#L29).
+
+### Code Style
+
+- We try to follow [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)
+- Comments should be generally avoided. If the code would not be understood without comments, consider re-writing the code to make it self-explanatory.
+
+### Code reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
+
+### Commit Messages
+
+Commit messages should follow the Semantic Commit Messages format:
+
+```
+label(namespace): title
+
+description
+
+footer
+```
+
+1. *label* is one of the following:
+    - `fix` - playwright bug fixes.
+    - `feat` - playwright features.
+    - `docs` - changes to docs, e.g. `docs(api.md): ..` to change documentation.
+    - `test` - changes to playwright tests infrastructure.
+    - `devops` - build-related work, e.g. CI related patches and general changes to the browser build infrastructure
+    - `chore` - everything that doesn't fall under previous categories
+2. *namespace* is put in parenthesis after label and is optional. Must be lowercase.
+3. *title* is a brief summary of changes.
+4. *description* is **optional**, new-line separated from title and is in present tense.
+5. *footer* is **optional**, new-line separated from *description* and contains "fixes" / "references" attribution to github issues.
+
+Example:
+
+```
+fix(firefox): make sure session cookies work
+
+This patch fixes session cookies in firefox browser.
+
+Fixes #123, fixes #234
+```
+
+## Contributor License Agreement
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+### Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.