toeverything/AFFiNE
1
1
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2024-12-23 02:21:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added docs folder and files

Browse Source
This commit is contained in:
CJSS 2022-10-26 09:37:45 +08:00
parent 4772ed170b
commit 01a01d971f
7 changed files with 291 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,45 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, 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.
## 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 within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. 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 maintainer. 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](https://www.contributor-covenant.org), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>

88
docs/CONTRIBUTING.md Normal file
View File

@ -0,0 +1,88 @@
# Welcome to our contributing guide <!-- omit in toc -->
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on our GitHub :sparkles:.
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. Join our [Discord](https://discord.com/invite/yz6tGVsf5p) server for more.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
## New contributor guide
To get an overview of the project, read the [README](../README.md). Here are some resources to help you get started with open source contributions:
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
## Getting started
Check to see what [types of contributions](types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
### Issues
#### Create a new issue or feature request
If you spot a problem, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/toeverything/AFFiNE/issues/new/choose).
#### Solve an issue
Scan through our [existing issues](https://github.com/toeverything/AFFiNE/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See our [Labels](https://github.com/toeverything/AFFiNE/labels) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
### Make Changes
#### Make changes in the UI
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
#### Make changes in a codespace
For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)."
#### Make changes locally
1. [Install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage).
2. Fork the repository.
- Using GitHub Desktop:
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
- Using the command line:
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
3. Install or update to **Node.js v16**. For more information, see [the development guide](contributing/development.md).
4. Create a working branch and start with your changes!
### Commit your update
Commit the changes once you are happy with them.
Reach out the community members for necessary help.
Once your changes are ready, don't forget to self-review to speed up the review process:zap:.
### Pull Request
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
### Your PR is merged!
Congratulations :tada::tada: The AFFiNE team thanks you :sparkles:.
Once your PR is merged, your contributions will be publicly visible on our GitHub.
Now that you are part of the AFFiNE community, see how else you can join and help over at [Gitbook](https://docs.affine.pro/affine/)

44
docs/jobs/affine.pro-remote.md Normal file
View File

@ -0,0 +1,44 @@
## What we do
We **AFFiNE** hold a vision of shaping a world semantically connected through block components in modern applications.
We're open for Fullstack Engineer positions across the BlockSuite sub-team. The **BlockSuite** team works on creating the best **block-editor** and **open-block** protocol for use in AFFiNE. Paving the way for a new generation of SaaS software and developers.
## Fullstack Engineer (Fully-Remote)
### This position is for:
- Developing AFFiNE **the open source way**, including coding and community engagement.
- Researching and supporting **onboarding process** of new use cases for AFFiNE.pro subscribers.
- Improving our **block editor** and **graphics editor**.
- Assisting our subscribers in utilizing our product in a data-based way with help from the operational teams.
- Researching on better activation of potential subscribers.
- Engineers who are self-organized individuals and also responsible team members, no matter they are on-site or working remotely.
### What we are looking for:
- Software engineering experience with **editor** or **graphics** and professional real-world use cases.
- Experience and proficiency in **TypeScript** and a **second programming language** preferably **Rust**.
- Strong communication and writing skills in English.
- Ability to work in a diverse and cross-functional team with skill and ease.
- A love for open source, sharing our visions and working under those values.
### It would be great if you are:
- Skillful in building UI with different web frameworks or native web components.
- Heavy user of knowledge/project management tools.
- Experienced in scaling **a successful SaaS product**.
- Experienced in developing platforms or tools for developers.
- Experienced in working with a **globally distributed team**.
- Enthusiastic about AFFiNE products as a user or contributor.
### What we offer:
- $2800 vouchers for latest MacBook Pro or working equipment of your choice.
- Public holidays and paid annual leave starting at 12 days.
- Become a maintainer of great open source projects and use Copilot powered by GitHub for free if you want.
### Contact us:
Interested? Send us your CV to [contact@toeverything.info](mailto:contact@toeverything.info).
Feel free to include any extra information (GitHub link, previous projects, personal blog etc.).

47
docs/jobs/affine.pro.md Normal file
View File

@ -0,0 +1,47 @@
## What we do
We **AFFiNE** hold a vision of shaping a world semantically connected through block components in modern applications.
We're open for Fullstack Engineer positions across the BlockSuite sub-team. The **BlockSuite** team works on creating the best **block-editor** and **open-block** protocol for use in AFFiNE. Paving the way for a new generation of SaaS software and developers.
## Fullstack Engineer
### This position is for:
- Developing AFFiNE **the open source way**, including coding and community engagement.
- Researching and supporting **onboarding process** of new use cases for AFFiNE.pro subscribers.
- Improving our **block editor** and **graphics editor**.
- Assisting our subscribers in utilizing our product in a data-based way with help from the operational teams.
- Researching on better activation of potential subscribers.
- Engineers who are self-organized individuals and also responsible team members, no matter they are on-site or working remotely.
-
### What we are looking for:
- Software engineering experience with **editor** or **graphics** and professional real-world use cases.
- Experience and proficiency in **TypeScript** and a **second programming language** preferably **Rust**.
- Strong communication and writing skills in English.
- Ability to work in a diverse and cross-functional team with skill and ease.
- A love for open source, sharing our visions and working under those values.
### It would be great if you are:
- Skillful in building UI with different web frameworks or native web components.
- Heavy user of knowledge/project management tools.
- Experienced in scaling **a successful SaaS product**.
- Experienced in developing platforms or tools for developers.
- Experienced in working with a **globally distributed team**.
- Enthusiastic about AFFiNE products as a user or contributor.
### What we offer:
- $2800 vouchers for latest MacBook Pro or working equipment of your choice.
- Public holidays and paid annual leave starting at 12 days.
- Free lunch, unlimited drinks and snacks.
- Free English language lessons (including free IELTS test) open to all employees.
- Become a maintainer of great open source projects and use Copilot powered by GitHub for free if you want.
### Contact us:
Interested? Send us your CV to [contact@toeverything.info](mailto:contact@toeverything.info).
Feel free to include any extra information (GitHub link, previous projects, personal blog etc.).

25
docs/jobs/mysc.app.md Normal file
View File

@ -0,0 +1,25 @@
## Full Stack Platform Engineer
### Your responsibilities will include
- Build APIs in the Data Platform to support new capabilities within mysc.
- Work with backend and client side databases (MongoDB, Redis, SQLite)
- Design and implement algorithms that are highly performant, resilient against failures and race conditions and are easy to use by application developers
- Build up solid knowledge of our product to understand end to end system behavior and data flow
- Execute performance profiling on existing systems to identify key bottlenecks and improve their performance characteristics
### What we're looking for
- Strong analytical thinking, planning, and problem-solving skills
- 3-5 years experience in building APIs or Platforms
- Strong computer science fundamentals, including knowledge of data structures, algorithmic complexity, and designing for performance and scalability
- Experience in NodeJS, TypeScript and Go
- Experience working with JWST
- Experience with unit / automated testing
### What we offer
- A fully remote team based on Gather Town
- A culture that encourages different opinions, respects different values and advocates work life balance
- Real ownership and actual impact
- Learning and career opportunities on the long run

13
docs/jobs/summary.md Normal file
View File

@ -0,0 +1,13 @@
# Jobs
- [<b>Fullstack Engineer - Global</b>](./affine.pro-remote.md) @[affine.pro](http://affine.pro/)
Rust ·TS · Virgo · JWST · Remote , Global
- [<b>Fullstack Engineer - China</b>](./affine.pro.md) @[affine.pro](http://affine.pro/)
Rust ·TS · Virgo · JWST · Remote , China
- [<b>Full Stack Platform Engineer</b>](./mysc.app.md) @[mysc.app](https://mysc.app/)
Rust · JWST · Remote · Shanghai, China

29
docs/types-of-contributions.md Normal file
View File

@ -0,0 +1,29 @@
# Types of contributions :memo:
You can contribute to AFFiNE in several ways. This repo is a place to discuss and collaborate on AFFiNE!
### :mega: Discussions
Discussions are where we have conversations.
If you'd like help troubleshooting a docs PR you're working on, have a great new idea, or want to share something amazing you've learned in our docs, join us in [discussions](https://github.com/toeverything/AFFiNE/discussions).
### :lady_beetle: Issues
[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with. If an issue has a triage label, we haven't reviewed it yet, and you shouldn't begin work on it.
If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/toeverything/AFFiNE/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
### :hammer_and_wrench: Pull requests
A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository. When we merge those changes, they should be deployed to the live site within 24 hours. :earth_africa:
You can [create a new pull request](https://github.com/toeverything/AFFiNE/compare) and view [current pull requests](https://github.com/toeverything/AFFiNE/pulls).
### :question: Support
We are a small team working hard to keep up with the documentation demands of a continuously changing product.
You may be able to find additional help and information on our social media platforms and groups - the links to these can be found in our [README](../README.md).
### :earth_asia: Translations
AFFiNE is internationalized and available in multiple languages. The source content in this repository is written in English. We integrate with an external localization platform to work with the community in localizing the English content. You can find more info in our [internationalization docs](https://docs.affine.pro/affine/internationalization/welcome).