Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme and add issue templates (#359)
* Updating the readme and contributing docs * add readme links * add issue templates * add bug and feature templates * update issue templates * fix markdown spacing in templates * update license so it is picked up by github * update readme links * fix license formatting
- Loading branch information
1 parent
8e5cd9a
commit f291bae
Showing
4 changed files
with
170 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest new features for the extension | ||
|
|
||
| --- | ||
|
|
||
| ## Summary | ||
| <!-- Explanation of the feature. --> | ||
|
|
||
| ## Motivation | ||
| <!-- | ||
| What use cases does it support? | ||
| What is the expected outcome? | ||
| Are there other extensions that have this feature? | ||
| --> | ||
|
|
||
| ## Additional context | ||
| <!-- | ||
| Include any additional context that you think would be helpful. Somethings you can include that will help us categorize the request are: | ||
| - Priority: Is this a nice to have feature or critical missing feature. | ||
| - Impact: Who will benefit from this feature? Will a small subset of uses want it or is this something all users will want. | ||
| - Screenshots or drawings if applicable. | ||
| - Examples of other extensions or applications that might have this feature. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Use this template for reporting a bug. | ||
|
|
||
| --- | ||
|
|
||
| <!-- | ||
| This form is for reporting bugs or issues with the extension and not to report broken sites. To report a broken site use the 'Report Broken Site' link on the extension popup. | ||
| **Make sure that the bug you are reporting is reproducible on the latest version of the extension** | ||
| --> | ||
|
|
||
| ## Description | ||
| <!-- Description of the issue --> | ||
|
|
||
| ## Steps to Reproduce | ||
| <!-- How can we reproduce the bug ourselves --> | ||
| 1. step 1 | ||
| 2. step 2 | ||
| 3. ... | ||
|
|
||
| **Expected behavior:** | ||
| <!-- What you expect to happen --> | ||
|
|
||
| **Actual behavior:** | ||
| <!-- What actually happens --> | ||
|
|
||
| **Versions** | ||
|
|
||
| <!-- | ||
| To find the extension versions: | ||
| Firefox: go to about:addons in the address bar, click DuckDuckGo Privacy Essentials, version is toward the bottom of the page. | ||
| Chrome: go to about:extensions in the address bar, click "details" on DuckDuckGo Privacy Essentials, the version is listed near the top of the page. | ||
| --> | ||
|
|
||
| - Extension: 20xx-xx-xx | ||
| - Browser: <!-- Firefox, Chrome, Vivaldi ... Version number is not needed, but let us know if you're not on the normal production version of the browser. --> | ||
| - OS: <!-- Windows, Linux, Mac. Version number for the OS is not needed --> | ||
|
|
||
| ## Additional Information | ||
| <!-- | ||
| Provide additional context (optional): | ||
| 1. Is the issue repeatable or intermittent? | ||
| 2. Did this issue start after an upgrade to a new extension version? If so, can you repeat it using a pervious extension version? | ||
| 3. Are there any errors in the extension debugging console? | ||
| 4. Include screenshots if they're helpful. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # Contributing guidelines | ||
|
|
||
| # Reporting broken sites | ||
|
|
||
| Report broken websites using the "Report Broken Site" link on the extension popup. | ||
|
|
||
| # Reporting bugs | ||
|
|
||
| 1. First check to see if the bug has not already been [reported](https://github.com/duckduckgo/duckduckgo-privacy-extension/issues). | ||
| 2. Create a bug report [issue](https://github.com/duckduckgo/duckduckgo-privacy-extension/issues/new?template=bug_report.md). | ||
|
|
||
| # Feature requests | ||
|
|
||
| There are two ways to submit feedback: | ||
| 1. You can send anonymous feedback using the "Send feedback" link on the extension's options page. | ||
| 2. You can submit your request as an [issue](https://github.com/duckduckgo/duckduckgo-privacy-extension/issues/new?template=feature_request.md). First check to see if the feature has not already been [suggested](https://github.com/duckduckgo/duckduckgo-privacy-extension/issues). | ||
|
|
||
| # Development | ||
|
|
||
| ## New features | ||
|
|
||
| Right now all new feature development is handled internally. | ||
|
|
||
| ## Bug fixes | ||
|
|
||
| Most bug fixes are handled internally, but we will except pull requests for bug fixes if you first: | ||
| 1. Create an issue describing the bug. see [Reporting bugs](CONTRIBUTING.md#reporting-bugs) | ||
| 2. Get approval from DDG staff before working on it. Since most bug fixes and feature development are handled internally, we want to make sure that your work doesn't conflict with any current projects. | ||
|
|
||
| ## Testing locally | ||
|
|
||
| ### Pre-Requisites | ||
| - [Node.js](https://nodejs.org) installation | ||
| - [Grunt](https://www.npmjs.com/package/grunt) | ||
| - Tests use [Selenium Webdriver](http://seleniumhq.github.io/selenium/docs/api/javascript/index.html). | ||
|
|
||
| ### Building the extension | ||
| - Firefox | ||
| 1. Run `npm run dev-firefox` | ||
| 2. Load the extension in Firefox from the `build/firefox/dev` directory | ||
| [Temporary installation in Firefox - Mozilla | MDN](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) | ||
|
|
||
| - Chrome | ||
| 1. Run `npm run dev-chrome` | ||
| 2. Load the extension in Chrome from the `build/chrome/dev` directory | ||
| [Getting Started: Building a Chrome Extension - Google Chrome](https://developer.chrome.com/extensions/getstarted#unpacked) | ||
|
|
||
| - Safari | ||
|
|
||
| The Safari extension is no longer supported. | ||
|
|
||
| ### Development flow | ||
|
|
||
| The `shared` directory contains JS, CSS, and images that are shared by all browsers. | ||
|
|
||
| The popup UI is in `shared/js/ui` | ||
|
|
||
| The background JS is in `shared/js/` | ||
|
|
||
| Browser specific files, including manifest files, are located in `browsers/<browser-name>` | ||
|
|
||
| Run the dev build task for your browser from the 'Build' section above. The generated build files are located in `/build/<browser>/dev`. | ||
|
|
||
| After running the build task it will continue watching for changes to any of the source files. After saving any changes to these files it will automatically rebuild the `dev` directory for you. | ||
|
|
||
| ### Testing | ||
| - Unit tests: `npm test` | ||
| - Integration Tests | ||
| - Local, requires Chrome: `npm run test-int` | ||
| - Headless, requires xvfb: `npm run test-ci` | ||
|
|
||
| ### Selenium Testing (ratings.js) | ||
|
|
||
| **Setup** | ||
|
|
||
| 1. For remote linux machine, first setup xvfb: `source selenium-test/setup.sh` | ||
| 2. `npm install` | ||
| 3. `grunt` | ||
|
|
||
| **Testing Single Site** `./selenium-test/ratings.js -u https://website.com` | ||
|
|
||
| **Testing Top 500** `./selenium-test/ratings.js -n 2` (where n = [1 - 500]) | ||
|
|
||
| **Testing Multiple Sites** `./selenium-test/ratings.js -f urls.txt` (file should have 1 url on each line) | ||
|
|
||
| **Using XVFB** To test on a remote server with XVBF installed, add `-x` flag: `./selenium-test/ratings.js -x -u https://website.com` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters