diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..d265e9d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,61 @@ +name: Bug report +description: File a bug +labels: ["bug", "triage"] +body: +- type: checkboxes + attributes: + label: Have you read a contributing guide? + description: Please read [CONTRINUTING.md](../blob/main/docs/CONTRIBUTING.md) before proceeding. Check if there are existing [bug reports](https://community.anytype.io/c/bug-reports/l/latest?board=default) and upvote them instead. Follow [this article](https://doc.anytype.io/d/community/community-forum) if you don't know how to join the community. + options: + - label: I have read CONTRIBUTING.md + required: true + - label: I have searched the existing issues and didn't find any that were similar + required: true + - label: I have considered creating a pull request with fixes instead of a bug report and want to proceed + required: true +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true +- type: textarea + attributes: + label: Environment + description: | + For example, + - **OS**: macOS 14 + - **Version**: 0.35.4 + value: | + - OS: + - Version: + render: markdown + validations: + required: true +- type: textarea + attributes: + label: Anything else? + description: | + Screenshots? Videos? Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..7c8e364 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Contributors Community + url: https://github.com/orgs/anyproto/discussions + about: A better place for contributing discussions. + - name: Anytype Community + url: https://community.anytype.io + about: Existing feature requests and bug reports from Anytype users. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..0e64ab2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,38 @@ +name: Feature request +description: Suggest an idea +labels: ["enhancement", "triage"] +body: +- type: checkboxes + attributes: + label: Have you read a contributing guide? + description: Please read [CONTRINUTING.md](../blob/main/docs/CONTRIBUTING.md) before proceeding. Check if there are existing [feature requests](https://community.anytype.io/c/feature-requests/l/latest?board=default) and upvote them instead. Follow [this article](https://doc.anytype.io/d/community/community-forum) if you don't know how to join the community. + options: + - label: I have read CONTRIBUTING.md + required: true + - label: I have searched the existing requests and didn't find any that were similar + required: true + - label: I have considered creating a pull request instead and want to proceed + required: true +- type: textarea + id: feature-description + attributes: + label: Clear and concise description of the problem + validations: + required: true +- type: textarea + id: suggested-solution + attributes: + label: Suggested solution + validations: + required: true +- type: textarea + id: alternative + attributes: + label: Alternative + description: Clear and concise description of any alternative solutions or features you've considered. +- type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context or screenshots about the feature request here. + diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..d2baece --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,57 @@ + + +--- + +- [ ] I understand that contributing to this repository will require me to agree with the [CLA](https://github.com/anyproto/open/blob/main/templates/CLA.md) + + + +--- + +### Description + + + +### What type of PR is this? (check all applicable) + +- [ ] 🍕 Feature +- [ ] 🐛 Bug Fix +- [ ] 📝 Documentation Update +- [ ] 🎨 Style +- [ ] 🧑‍💻 Code Refactor +- [ ] 🔥 Performance Improvements +- [ ] ✅ Test +- [ ] 🤖 Build +- [ ] 🔁 CI + +### Related Tickets & Documents + + +### Mobile & Desktop Screenshots/Recordings + + + +### Added tests? + +- [ ] 👍 yes +- [ ] 🙅 no, because they aren't needed +- [ ] 🙋 no, because I need help + +### Added to documentation? + +- [ ] 📜 README.md +- [ ] 📓 [tech-docs](https://github.com/anyproto/tech-docs) +- [ ] 🙅 no documentation needed + +### [optional] Are there any post-deployment tasks we need to perform? + + + diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml new file mode 100644 index 0000000..25057df --- /dev/null +++ b/.github/workflows/cla.yml @@ -0,0 +1,45 @@ +name: "CLA Assistant" +on: + issue_comment: + types: [created] + pull_request_target: + types: [opened,closed,synchronize] + +permissions: + actions: write + contents: write + pull-requests: write + statuses: write + +jobs: + CLAAssistant: + if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' + runs-on: ubuntu-latest + steps: + - name: Get Org Members + id: members + uses: octokit/request-action@v2.x + with: + route: GET /orgs/anyproto/members + env: + GITHUB_TOKEN: ${{ secrets.ANY_CLA_TOKEN }} + + - name: Extract Member Logins + run: | + echo '${{ steps.members.outputs.data }}' | jq -r '.[].login' | tr '\n' ',' > members.txt + echo "dependabot" >> members.txt + echo "members=$(cat members.txt)" >> "$GITHUB_ENV" + + - name: CLA Assistant + uses: contributor-assistant/github-action@v2.3.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PERSONAL_ACCESS_TOKEN: ${{ secrets.ANY_CLA_TOKEN }} + with: + custom-notsigned-prcomment: '
Thank you for your pull request, we really appreciate it!

Please sign our [Contributor License Agreement](https://github.com/anyproto/open/blob/main/templates/CLA.md) before we can accept your contribution.
You can sign the CLA by simply commenting on this pull request with the following text.
' + path-to-document: "https://github.com/anyproto/open/blob/main/templates/CLA.md" + remote-organization-name: "anyproto" + remote-repository-name: "cla" + branch: "main" + path-to-signatures: "signatures.json" + allowlist: ${{ env.members }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e43b0f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/README.md b/README.md index 7d43cab..8209658 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,15 @@ Protobuf facilitates data exchange between different systems written in differen - `events.proto` describes the events about the changes of objects and blocks. These events are used to notify clients and also serve as CDRT changes to be stored in an object's tree. ## Contribution -Thank you for your desire to develop Anytype together. +Thank you for your desire to develop Anytype together! -Currently, we're not ready to accept PRs, but we will in the nearest future. +❤️ This project and everyone involved in it is governed by the [Code of Conduct](docs/CODE_OF_CONDUCT.md). -Follow us on [Github](https://github.com/anyproto) and join the [Contributors Community](https://github.com/orgs/anyproto/discussions). +🧑‍💻 Check out our [contributing guide](docs/CONTRIBUTING.md) to learn about asking questions, creating issues, or submitting pull requests. + +🫢 For security findings, please email [security@anytype.io](mailto:security@anytype.io) and refer to our [security guide](docs/SECURITY.md) for more information. + +🤝 Follow us on [Github](https://github.com/anyproto) and join the [Contributors Community](https://github.com/orgs/anyproto/discussions). --- Made by Any — a Swiss association 🇨🇭 diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6ee035d --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +support@anytype.io. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..a9ffe67 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,120 @@ +# Contributing to Anytype + +First off, thank you for your desire to develop Anytype together! + +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> - Follow us on Github +> - Star our repos +> - Tweet about [@AnytypeLabs](https://twitter.com/AnytypeLabs) +> - Mention Anytype at local meetups and tell your friends/colleagues + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Preferred Languages](#preferred-languages) +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Requesting Features](#requesting-features) + - [Reporting Security Issues](#reporting-security-issues) + - [Contributing Code](#contributing-code) +- [Contributors Recognition](#contributors-recognition) + +## Code of Conduct + +This project and everyone participating in it is governed by the +[Code of Conduct](CODE_OF_CONDUCT.md). +By participating, you are expected to uphold this code. Please report unacceptable behavior to [support@anytype.io](mailto:support@anytype.io). + +## Preferred Languages + +We prefer all communications to be in English. + +## I Have a Question + +> Here on GitHub, we're discussing everything related to building Anytype. If you have any questions about how to use Anytype, please join our [community](https://community.anytype.io) or contact us via [support@anytype.io](mailto:support@anytype.io). +> +> If you want to ask a technical question, we assume that you have read the project's [README](../README.md) and our [tech documentation](https://tech.anytype.io). + +Before you ask a question, it is best to look into our [Contributors Community](https://github.com/orgs/anyproto/discussions). In case you have found a suitable topic and still need clarification, you can write a comment there. + +Feel free to create a new topic in [Contributors Community](https://github.com/orgs/anyproto/discussions) if the question is still unsolved :) + +We recommend the following: + +- Provide as much context as you can about what you're running into. +- Provide project and platform versions, depending on what seems relevant. + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. For PRs our bot will ask you to accept the [Contributor License Agreement](https://github.com/anyproto/open/blob/main/templates/CLA.md). + +### Reporting Bugs + +#### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. + +- Make sure that you are using the latest version. +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (If you are looking for support, you might want to check [this section](#i-have-a-question)). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](issues?q=label%3Abug) or in [existing bug reports](https://community.anytype.io/c/bug-reports/l/latest?board=default) created by users. + +#### How Do I Submit a Good Bug Report? + +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [security@anytype.io](mailto:security@anytype.io) (please see [SECURITY.md](SECURITY.md) for details). + +If you run into an issue with the project: + +- Open an [Issue](/issues/new/choose) +- Click `Get started` next to `Bug report` section +- Explain the behavior you would expect and the actual behavior. +- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. +- Provide the information you collected in the previous section. + +Once it's filed: + +- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps. +- If the team is able to reproduce the issue and the issue will be left to be addressed by the team or contributors. + +### Requesting Features + +#### Before Requesting a Feature + +- Make sure that you are using the latest version. +- If you are looking for support, you might want to check [this section](#i-have-a-question). +- To see if other users already requested something similar you are suggesting, check the [tracker](issues?q=label%3Aenhancement) or [feature requests](https://community.anytype.io/c/feature-requests/l/latest?board=default) created by users. + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](/issues). + +- Open an [Issue](/issues/new/choose) +- Click `Get started` next to `Feature request` section +- Follow the template and feel free to add more details + +### Reporting Security Issues + +You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [security@anytype.io](mailto:security@anytype.io) (please see [SECURITY.md](SECURITY.md) for details). + +### Contributing Code +When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. Our bot will ask you to accept the [Contributor License Agreement](https://github.com/anyproto/open/blob/main/templates/CLA.md) before we can accept the pull request. + +Basic rules for pull requests: +- Pull requests generally need to be based on and opened against the `main` branch, unless by explicit agreement because the work is contributing to some more complex feature branch +- Please follow a suggested template for the pull request description +- When neccesary, changes are documented in [`README.md`](../README.md) or suggestions are also made to [`tech-docs`](https://github.com/anyproto/tech-docs) + +All pull requests will be reviewed by the team. + +## Contributors Recognition + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! + +You can check the list of contributors in a [dedicated repo](https://github.com/anyproto/contributors). + +--- + +*This guide is based on the [`contributing.md`](https://contributing.md/example/).* diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 100644 index 0000000..07776d3 --- /dev/null +++ b/docs/SECURITY.md @@ -0,0 +1,30 @@ + +## Security + +We take the security of our software products and services seriously. + +If you believe you have found a security vulnerability in any repository of Any Association, please report it to us as described below. + +## Reporting Security Issues + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please send email to [security@anytype.io](mailto:security@anytype.io). + +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. + +Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: + + * Type of issue + * Full paths of source file(s) related to the manifestation of the issue + * The location of the affected source code (tag/branch/commit or direct URL) + * Any special configuration required to reproduce the issue + * Step-by-step instructions to reproduce the issue + * Proof-of-concept or exploit code (if possible) + * Impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. + +## Preferred Languages + +We prefer all communications to be in English. \ No newline at end of file