-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
License and contributor guidelines for open-sourcing (#1189)
Task/Issue URL: https://app.asana.com/0/0/1204570090717197/f **Description**: Adding necessary documents for open-sourcing
- Loading branch information
1 parent
c5e0adf
commit 481ef20
Showing
3 changed files
with
122 additions
and
13 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,33 @@ | ||
# Contributing to DuckDuckGo | ||
|
||
Thank you for taking the time to contribute to DuckDuckGo! :sparkles: | ||
|
||
We are pleased to open up the project to you - our community. How can you contribute? | ||
|
||
## Share feedback | ||
Contact us at https://duckduckgo.com/feedback if you have feedback, questions or want to chat. You can also use the feedback form embedded within our app - to do so please go to Main Menu -> Help -> Send Feedback. | ||
|
||
## Report an issue | ||
A great way to contribute to the project is to report an issue when you encounter a problem. | ||
|
||
We want our app to be as stable as possible thus your bug reports are immensely valuable. When reporting bugs let us know the: | ||
* App version | ||
* macOS version | ||
* Steps to reproduce the bug | ||
* Expected behavior | ||
* Actual behavior | ||
|
||
If you have encountered a security issue, please reach us through https://hackerone.com/duckduckgo. | ||
|
||
## Contributing Code | ||
We're always open to contributions from the community! There are different approaches depending on how you wish to contribute: | ||
|
||
* **For bug fixes**, feel free to open a pull request along with an associated issue. Someone from the team will review your issue/change within a few days. | ||
* **For new features**, start by logging an issue with a description of your idea. Proposals that fit our product direction and timeline will be added to our backlog and labelled accordingly. | ||
* If you're looking for a bug to work on, see the [Help Wanted](https://github.com/duckduckgo/macOS/issues?q=is%3Aissue+is%3Aopen+label%3A%22Help+Wanted%22) tag for a list of open issues. | ||
|
||
### Style Guide | ||
We care about clean code. Refer to our [style guide](https://github.com/duckduckgo/iOS/blob/develop/styleguide/STYLEGUIDE.md). | ||
|
||
### Commit Messages | ||
See Chris Beams' guide to writing good commit messages https://chris.beams.io/posts/git-commit/ |
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,52 @@ | ||
Copyright (c) 2023 Duck Duck Go, Inc. | ||
|
||
## Apache License | ||
### Version 2.0, January 2004 | ||
###### http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
**1. Definitions.** | ||
|
||
"**License**" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"**Licensor**" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. | ||
|
||
"**Legal Entity**" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "**control**" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"**You**" (or "**Your**") shall mean an individual or Legal Entity exercising permissions granted by this License. | ||
|
||
"**Source**" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. | ||
|
||
"**Object**" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. | ||
|
||
"**Work**" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). | ||
|
||
"**Derivative Works**" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. | ||
|
||
"**Contribution**" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "**submitted**" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "**Not a Contribution.**" | ||
|
||
"**Contributor**" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. | ||
|
||
**2. Grant of Copyright License**. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. | ||
|
||
**3. Grant of Patent License**. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. | ||
|
||
**4. Redistribution**. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: | ||
1. You must give any other recipients of the Work or Derivative Works a copy of this License; and | ||
1. You must cause any modified files to carry prominent notices stating that You changed the files; and | ||
1. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and | ||
1. If the Work includes a "**NOTICE**" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. | ||
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. | ||
|
||
**5. Submission of Contributions**. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. | ||
|
||
**6. Trademarks**. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
**7. Disclaimer of Warranty**. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. | ||
|
||
**8. Limitation of Liability**. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. | ||
|
||
**9. Accepting Warranty or Additional Liability**. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS |
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 |
---|---|---|
@@ -1,28 +1,52 @@ | ||
# DuckDuckGo Privacy Browser for macOS | ||
# DuckDuckGo for macOS | ||
|
||
We are excited to engage the community in development! | ||
|
||
## We are hiring! | ||
DuckDuckGo is growing fast and we continue to expand our fully distributed team. We embrace diverse perspectives, and seek out passionate, self-motivated people, committed to our shared vision of raising the standard of trust online. If you are a senior software engineer, visit our [careers](https://duckduckgo.com/hiring/#open) page to find out more about our openings! | ||
|
||
## Building | ||
|
||
The app uses submodules, which will need to be cloned in order for the project to build: | ||
### Submodules | ||
We use submodules, so you will need to bring them into the project in order to build and run it: | ||
|
||
Run `git submodule update --init --recursive` | ||
|
||
## Schemes | ||
### Developer details | ||
If you're not part of the DuckDuckGo team, go to Signing & Capabilities to select your team and custom bundle identifier. | ||
|
||
### Dependencies | ||
We use Swift Package Manager for dependency management, which shouldn't require any additional set up. | ||
|
||
`DuckDuckGo Privacy Browser` is the primary scheme. Use it for development, testing and releases. | ||
Use `Product Review Release` scheme for exporting builds for a product review or product feedback request. | ||
Use `Pull Request Testing with TSan` for testing a build in Release configuration before approving a pull request. | ||
### SwiftLint | ||
We use [SwifLint](https://github.com/realm/SwiftLint) for enforcing Swift style and conventions, so you'll need to [install it](https://github.com/realm/SwiftLint#installation). | ||
|
||
## Duck player | ||
### Duck Player | ||
|
||
To build the JS for the duck player: | ||
To build the JS for Duck Player: | ||
|
||
- first run `npm install` - please ensure you have `node 16` or above | ||
- then run `npm run build-yt` - this will build from `js/youtube-player` & copy the artifact into `DuckDuckGo/Youtube Player/Resources/youtube-inject-bundle.js` | ||
- to have it continuously re-compile, run `npm run build-yt:watch` | ||
1. First run `npm install` - please ensure you have `node 16` or above. | ||
2. Then run `npm run build-yt` - this will build from `js/youtube-player` & copy the artifact into `DuckDuckGo/Youtube Player/Resources/youtube-inject-bundle.js`. | ||
3. To have it continuously re-compile, run `npm run build-yt:watch`. | ||
|
||
Notes for Duck Player | ||
|
||
- `youtube-inject.js` is the entry point for the JavaScript Bundle that's used by `YoutubeOverlayUserScript.swift` | ||
- when you 'build' the JavaScript bundle, changes to the compiled artifact `youtube-inject-bundle.js` should also be checked in when you commit. | ||
- if you make any changes, please run the integration tests | ||
- When you 'build' the JavaScript bundle, changes to the compiled artifact `youtube-inject-bundle.js` should also be checked in when you commit. | ||
- If you make any changes, please run the integration tests: | ||
- `cd js/youtube-player && npm run test.integration` | ||
|
||
## Terminology | ||
|
||
We have taken steps to update our terminology and remove words with problematic racial connotations, most notably the change to `main` branches, `allow lists`, and `blocklists`. Closed issues or PRs may contain deprecated terminology that should not be used going forward. | ||
|
||
## Contribute | ||
|
||
Please refer to [contributing](CONTRIBUTING.md). | ||
|
||
## Discuss | ||
|
||
Contact us at https://duckduckgo.com/feedback if you have feedback, questions or want to chat. You can also use the feedback form embedded within our app - to do so please go to Main Menu -> Help -> Send Feedback. | ||
|
||
## License | ||
DuckDuckGo is distributed under the Apache 2.0 [license](LICENSE.md). |