diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..89e7451 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct for fdc3-dotnet + +Please see the [Community Code of Conduct](https://www.finos.org/code-of-conduct). diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 0000000..3259822 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,24 @@ +--- +name: 🐛 Bug Report +about: If something isn't working as expected 🤔. + +--- + +## Bug Report + +### Steps to Reproduce: + 1. ...step 1 description... + 2. ...step 2 description... + 3. ...step 3 description... + +### Expected Result: +...description of what you expected to see... + +### Actual Result: +...what actually happened, including full exceptions (please include the entire stack trace, including "caused by" entries), log entries, screen shots etc. where appropriate... + +### Environment: +...version and build of the project, OS and runtime versions, virtualised environment (if any), etc. ... + +### Additional Context: +...add any other context about the problem here. If applicable, add screenshots to help explain... diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 0000000..b01f152 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,17 @@ +--- +name: 🚀 Feature Request +about: I have a suggestion (and may want to implement it 🙂)! + +--- + +## Feature Request + +### Description of Problem: +...what *problem* are you trying to solve that the project doesn't currently solve? + +...please resist the temptation to describe your request in terms of a solution. Job Story form ("When [triggering condition], I want to [motivation/goal], so I can [outcome].") can help ensure you're expressing a problem statement. + +### Potential Solutions: +...clearly and concisely describe what you want to happen. Add any considered drawbacks. + +... if you've considered alternatives, clearly and concisely describe those too. diff --git a/.github/ISSUE_TEMPLATE/Meeting_minutes.md b/.github/ISSUE_TEMPLATE/Meeting_minutes.md new file mode 100644 index 0000000..ede1623 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Meeting_minutes.md @@ -0,0 +1,51 @@ +--- +name: "\U0001F91D fdc3-dotnet Meeting Minutes" +about: To track fdc3-dotnet meeting agenda and attendance +title: DD MMM YYYY - fdc3-dotnet Meeting Minutes +labels: meeting +assignees: + +--- + + + ## Date +YYYYMMDD - time + +## Untracked attendees +- Fullname, Affiliation, (optional) GitHub username +- ... + +## Meeting notices +- FINOS **Project leads** are responsible for observing the FINOS guidelines for [running project meetings](https://community.finos.org/docs/governance/meeting-procedures/). Project maintainers can find additional resources in the [FINOS Maintainers Cheatsheet](https://community.finos.org/docs/finos-maintainers-cheatsheet). + +- **All participants** in FINOS project meetings are subject to the [LF Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), the [FINOS Community Code of Conduct](https://community.finos.org/docs/governance/code-of-conduct) and all other [FINOS policies](https://community.finos.org/docs/governance/#policies). + +- FINOS meetings involve participation by industry competitors, and it is the intention of FINOS and the Linux Foundation to conduct all of its activities in accordance with applicable antitrust and competition laws. It is therefore extremely important that attendees adhere to meeting agendas, and be aware of, and not participate in, any activities that are prohibited under applicable US state, federal or foreign antitrust and competition laws. Please contact legal@finos.org with any questions. + +- FINOS project meetings may be recorded for use solely by the FINOS team for administration purposes. In very limited instances, and with explicit approval, recordings may be made more widely available. + +## Agenda +- [ ] Convene & roll call (5mins) +- [ ] Display [FINOS Antitrust Policy summary slide](https://community.finos.org/Compliance-Slides/Antitrust-Compliance-Slide.pdf) +- [ ] Review Meeting Notices (see above) +- [ ] Approve past meeting minutes +- [ ] Agenda item 1 +- [ ] Agenda item 2 +- [ ] ... +- [ ] AOB, Q&A & Adjourn (5mins) + +## Decisions Made +- [ ] Decision 1 +- [ ] Decision 2 +- [ ] ... + +## Action Items +- [ ] Action 1 +- [ ] Action 2 +- [ ] ... + +### WebEx info +- Meeting link: +- Meeting number: +- Password: +- Call-in: diff --git a/.github/ISSUE_TEMPLATE/Support_question.md b/.github/ISSUE_TEMPLATE/Support_question.md new file mode 100644 index 0000000..c6c4deb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Support_question.md @@ -0,0 +1,11 @@ +--- +name: 🤗 Support Question +about: If you have a question about configuration, usage, etc. 💬 + +--- + +## Support Question + +...ask your question here. + +...be sure to search existing issues since someone might have already asked something similar. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae7ded2..ebeb5ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,139 +1,55 @@ -# Contributing - -When contributing to this repository, please first discuss the change you wish -to make via issue, email, or any other method with the owners of this repository -before making a change. - -Please note we have a code of conduct, please follow it in all your interactions -with the project. - -## Before your first pull request - -If you have not previously contributed to the project, -you must first create a *Developer Certificate of Origin* (“DCO”) and include a -reference to this DCO in each of your commits. In addition, if you subsequently -wish to contribute code having a different copyright ownership, then you must create -a new DCO for such contribution. - -To create a DCO please follow these steps: - -1. For code you are contributing, determine who is/are the copyright owner(s). -Please note that your employer may own the copyright in code you have written even -where the code was not created during regular working hours. Copyright law is -variable from jurisdiction to jurisdiction. Accordingly, consult your employer -or a lawyer if you are not sure. -2. Fill out the [DCO](dco/dco_template.md) replacing all `<>` terms as appropriate, and place the -completed DCO in a file under `dco/` or if you are not the copyright -holder then in a file under `dco/-`. - 1. Please note that the name you provide (``) must be your real - (legal) name; we will not accept aliases, pseudonyms or anonymous - contributions. - 1. If you’ve determined that the copyright holder of the code that you’ve - written is an entity other than yourself (e.g., your employer), then - include the legal name of the copyright holder(s) (``). - You must ensure that you are authorized by the copyright holder(s) to be able - to grant the licenses under the DCO for the purpose of contributing to the - project. Negotiating such authorization and administering the terms is - entirely between you and the copyright holder(s). -3. Issue a pull request with the DCO. - -## Pull request process - -When you create a pull request, follow these steps: - -1. Your commit message for the code you are submitting must include a -`“Covered by “` line which indicates your acceptance of the DCO terms and conditions. -`` here is the file name of the DCO. -2. Your commit must include a change to the `NOTICE` file that contains complete -details of any applicable copyright notice for your submission and including any -applicable third party license(s) or other restrictions associated with any part -of your contribution, and of all matters required to be disclosed under such third -party license(s) (such as any applicable copyright, patent, trademark, and attribution -notices, and any notices relating to modifications made to open source software). -Note your contribution must retain all applicable copyright, patent, trademark and -attribution notices. - -## Pull request guidelines - -* Update the README.md/docs with details of changes to the interface. -* Update an existing or add a new testcase for your change. -* Ensure any install or build artifacts are removed from the pull request. -* We generally prefer squashed commits, unless multi-commits add clarity or are required for mixed copyright commits. -* You may merge the Pull Request in once the build has passed and you have the - sign-off of one other developer, or if you do not have permission to do that, - you may request the reviewer to merge it for you. - -## Code of Conduct - -### Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -### Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -### Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -### Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -### Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at opensource [at] morganstanley.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -### Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file +# fdc3-dotnet Contribution and Governance Policies + +This document describes the contribution process and governance policies of the FINOS fdc3-dotnet project. The project is also governed by the [Linux Foundation Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), and the FINOS [IP Policy]( https://community.finos.org/governance-docs/IP-policy.pdf), [Code of Conduct](https://community.finos.org/docs/governance/code-of-conduct), [Collaborative Principles](https://community.finos.org/docs/governance/collaborative-principles/), and [Meeting Procedures](https://community.finos.org/docs/governance/meeting-procedures/). + +## Contribution Process + +Before making a contribution, please take the following steps: +1. Check whether there's already an open issue related to your proposed contribution. If there is, join the discussion and propose your contribution there. +2. If there isn't already a relevant issue, create one, describing your contribution and the problem you're trying to solve. +3. Respond to any questions or suggestions raised in the issue by other developers. +4. Fork the project repository and prepare your proposed contribution. +5. Submit a pull request. + +NOTE: All contributors must have a contributor license agreement (CLA) on file with FINOS before their pull requests will be merged. Please review the FINOS [contribution requirements](https://community.finos.org/docs/governance/Software-Projects/contribution-compliance-requirements) and submit (or have your employer submit) the required CLA before submitting a pull request. + +## Governance + +### Roles + +The project community consists of Contributors and Maintainers: +* A **Contributor** is anyone who submits a contribution to the project. (Contributions may include code, issues, comments, documentation, media, or any combination of the above.) +* A **Maintainer** is a Contributor who, by virtue of their contribution history, has been given write access to project repositories and may merge approved contributions. +* The **Lead Maintainer** is the project's interface with the FINOS team and Board. They are responsible for approving [quarterly project reports](https://community.finos.org/docs/governance/#project-governing-board-reporting) and communicating on behalf of the project. The Lead Maintainer is elected by a vote of the Maintainers. + +### Contribution Rules + +Anyone is welcome to submit a contribution to the project. The rules below apply to all contributions. (The key words "MUST", "SHALL", "SHOULD", "MAY", etc. in this document are to be interpreted as described in [IETF RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).) + +* All contributions MUST be submitted as pull requests, including contributions by Maintainers. +* All pull requests SHOULD be reviewed by a Maintainer (other than the Contributor) before being merged. +* Pull requests for non-trivial contributions SHOULD remain open for a review period sufficient to give all Maintainers a sufficient opportunity to review and comment on them. +* After the review period, if no Maintainer has an objection to the pull request, any Maintainer MAY merge it. +* If any Maintainer objects to a pull request, the Maintainers SHOULD try to come to consensus through discussion. If not consensus can be reached, any Maintainer MAY call for a vote on the contribution. + +### Maintainer Voting + +The Maintainers MAY hold votes only when they are unable to reach consensus on an issue. Any Maintainer MAY call a vote on a contested issue, after which Maintainers SHALL have 36 hours to register their votes. Votes SHALL take the form of "+1" (agree), "-1" (disagree), "+0" (abstain). Issues SHALL be decided by the majority of votes cast. If there is only one Maintainer, they SHALL decide any issue otherwise requiring a Maintainer vote. If a vote is tied, the Lead Maintainer MAY cast an additional tie-breaker vote. + +The Maintainers SHALL decide the following matters by consensus or, if necessary, a vote: +* Contested pull requests +* Election and removal of the Lead Maintainer +* Election and removal of Maintainers + +All Maintainer votes MUST be carried out transparently, with all discussion and voting occurring in public, either: +* in comments associated with the relevant issue or pull request, if applicable; +* on the project mailing list or other official public communication channel; or +* during a regular, minuted project meeting. + +### Maintainer Qualifications + +Any Contributor who has made a substantial contribution to the project MAY apply (or be nominated) to become a Maintainer. The existing Maintainers SHALL decide whether to approve the nomination according to the Maintainer Voting process above. + +### Changes to this Document + +This document MAY be amended by a vote of the Maintainers according to the Maintainer Voting process above. diff --git a/LICENSE b/LICENSE index 261eeb9..53de34a 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright 2023 Morgan Stanley Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/NOTICE b/NOTICE index 86aad61..b848dd0 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -fdc3-dotnet +fdc3-dotnet - FINOS This product includes software developed at Morgan Stanley (http://www.morganstanley.com). diff --git a/README.md b/README.md index 2d3e13b..c035e78 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,66 @@ fdc3-dotnet =========== +[![FINOS - Incubating](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg)](https://community.finos.org/docs/governance/Software-Projects/stages/incubating) ![Lifecycle Incubating](https://badgen.net/badge/Lifecycle/Incubating/yellow) [![CI](https://github.com/morganstanley/fdc3-dotnet/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/morganstanley/fdc3-dotnet/actions/workflows/continuous-integration.yml) .NET Standard 2.0 declarations to implement concrete [FDC3](https://fdc3.finos.org/) compatible .NET desktop agents and usage of intents/context. + +## Getting Involved + +### Using the standard? Let us know + +If you are an existing individual or corporate user of the FDC3 standard, we would love to hear from you: just email [fdc3@finos.org](mailto:fdc3@finos.org) with details about how you are using the standard. + +- If you'd like to be listed as on the community page, please fill out the [Usage Form](https://share.hsforms.com/1gOo0_A70QqyahOygzryVQg1fux8). +- If listing your logo publicly requires legal evaluation, you can reach out **privately** to the [FDC3 Maintainers](mailto:fdc3-maintainers-private@finos.org). + +### Interact with the FDC3 community + +#### GitHub + +- FDC3 activity primarily happens in this [FDC3 GitHub repository](https://github.com/finos/fdc3). [Watch](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) the repository in order to be notified of new Pull Requests and issues. + +#### Slack + +- The fastest and more interactive way to connect and ask questions to the FDC3 community is to join the [#fdc3 channel on the FINOS slack](https://finos-lf.slack.com/messages/fdc3/). + +#### Email + +- If you'd like to receive official updates, and/or you don't have access to Slack, please send an email to [fdc3@finos.org](mailto:fdc3@finos.org). You can join the list by sending an email to [fdc3+subscribe@finos.org](mailto:fdc3+subscribe@finos.org). +- To contact the FDC3 maintainers, send an email to [fdc3-maintainers@finos.org](mailto:fdc3-maintainers@finos.org). + +#### Meetings + +- Finally, another great way to interact with the community, is to attend the monthly [FDC3 Standard Working Group Meeting](https://github.com/finos/FDC3/issues?q=label%3A%22Standard+WG+Meeting%22) and/or the quarterly [FDC3 General Meeting](https://github.com/finos/FDC3/issues?q=label%3A%22General+Meeting%22). +- Email [help@finos.org](mailto:help@finos.org) to be added to the meeting invite directly, or find the meeting in the [FINOS Community Calendar](https://calendar.google.com/calendar/embed?src=finos.org_fac8mo1rfc6ehscg0d80fi8jig%40group.calendar.google.com). + +#### Need help? + +- Email [fdc3@finos.org](mailto:fdc3@finos.org) if you need help getting started in the FDC3 Community. +- If you encounter technical difficulties accessing repositories, joining Slack, mailing lists or meetings, please email [help@finos.org](mailto:help@finos.org). + +## Contributing +For any questions, bugs or feature requests please open an [issue](https://github.com/finos/fdc3-dotnet/issues). + +To submit a contribution: +1. Fork it () +2. Create your feature branch (`git checkout -b feature/fooBar`) +3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct) +4. Commit your changes (`git commit -am 'Add some fooBar'`) +5. Push to the branch (`git push origin feature/fooBar`) +6. Create a new Pull Request + +_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool (or [EasyCLA](https://community.finos.org/docs/governance/Software-Projects/easycla)). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. + +*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)* + +## License + +Copyright 2023 Morgan Stanley + +Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). + +SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0) + diff --git a/dco/dco_template.md b/dco/dco_template.md deleted file mode 100644 index 414b8f4..0000000 --- a/dco/dco_template.md +++ /dev/null @@ -1,73 +0,0 @@ -# DEVELOPER CERTIFICATE OF ORIGIN - -Thank you for your interest in the open source software project(s) (the “Project”) maintained or managed by -Morgan Stanley Services Group Inc. (“us” or “we”). The purpose of this Developer Certificate of Origin (the “DCO” or -“Agreement”) is to define the intellectual property license granted by persons or entities that make Contributions -(defined below) to the Project. You, **``**, agree and certify as set forth in this Agreement. You may be -contacted at **``**. - -By submitting a Contribution, including but not limited to by pull request, you agree that you have read and -understood this Agreement and you will be legally bound thereby. In consideration of the opportunity to -participate in the community of Project contributors, you hereby agree to the following terms and conditions in -connection with your present and future Contributions: - -1. **Contributions:** - * The term “Contribution” means any source code, object code, patch, tool, sample, graphic, specification, - manual, documentation, or any other material submitted by you to the Project. - * A Contribution is “submitted” when any form of electronic, verbal, or written communication is sent to the - Project, 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 Project for the purpose of discussing or - improving software or documentation of the Project (“Communication”). - * Each Communication that is conspicuously marked or designated by you in writing as “Not a Contribution” will - not be considered a Contribution. - * Any Contribution submitted by you to the Project will be under the terms and conditions of this Agreement - without any additional terms or conditions. - -2. **Grant of License:** You hereby grant us and our affiliates, for purposes of the Project, and to recipients of -software distributed by the Project: - * a perpetual, irrevocable, non-exclusive, worldwide, fully paid-up, royalty-free, unrestricted license to - exercise all rights (including sublicensing and commercial exploitation) under all worldwide copyrights, - copyright applications and registrations in the Contribution; and - * a perpetual, irrevocable, non-exclusive, worldwide, full paid-up, royalty-free patent license to make, - have made, use, offer to sell, sell, import, and otherwise transfer your Contribution and derivative works - thereof, where such license applies only to those patent claims licensable by you or your affiliates that - are necessarily infringed by your Contribution alone or by combination of your Contribution with the Project - to which you submitted the Contribution. - -3. **Ownership:** - * Except as set out above, you keep all right, title and interest in your Contribution. - * You represent that: - 1. you are the owner of the Contribution or are otherwise legally entitled to grant the above licenses; - 1. if any third party, including your employer and/or its affiliates, has rights to any intellectual - property included in your Contribution, then (i) each such third party has provided you written permission - to make the Contribution as specified herein or a written waiver of such rights in and to your Contribution, - **`[and (ii) such third party(ies) is/are ]`**; - 1. your Contribution is an original work created by you, and except for third parties who have given - permission to make the Contribution as set forth above, to your knowledge, no other person or entity has - claimed, claims, or has the right to claim any right whatsoever in the Contribution; and - 1. your Contribution includes complete details of any third party license(s) or other restriction(s) - (including, but not limited to, related copyrights, patents and trademarks) of which you are aware and - which are associated with any part of your Contribution, and of all matters required to be disclosed under - such third party licenses (such as all applicable copyright, patent, trademark and attribution notices, and - all modifications made to certain open source software). - -4. **Notice; Inclusion; No Confidentiality:** - * You agree to notify us of any facts or circumstances of which you become aware that would make these - representations inaccurate in any respect. Notices and other communications to be sent as directed in the - applicable Project - * Neither we nor the Project is under any obligation to accept and include your Contribution, or to return it to you. - * You will not, absent a separate written agreement signed by us, impose any confidentiality obligations - on us, and we have not undertaken any obligation to treat any Contributions or other information you have - or will give us as confidential or proprietary information. - * You understand and agree that all Contributions including all personal information you submit with it may - be maintained indefinitely and may be redistributed consistent with the applicable open source license(s). - -5. **Effective Date:** The rights that you grant to us under these terms are effective on the date you first -submit a Contribution to us, even if your submission took place before the date you accept the terms of this Agreement. - -6. **Governing Law; Entire Agreement:** This Agreement is governed by the laws of the State of New York, -without regard to its choice of law provisions, and by the laws of the United States. This Agreement sets -forth the entire understanding and agreement between the parties, and supersedes any previous communications, -representations or agreements, whether oral or written, regarding the subject matter herein. No alteration, waiver, -amendment, change or supplement hereto shall be binding or effective unless the same is set forth in writing -signed by both parties. We may freely assign our rights or obligations under this Agreement.