Merge branch 'master' of github.com:appwrite/appwrite into 0.7.x
This commit is contained in:
commit
b12097efec
2 changed files with 100 additions and 0 deletions
|
@ -10,6 +10,52 @@ If you are worried or don’t know where to start, check out our next section ex
|
||||||
|
|
||||||
Help us keep Appwrite open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md).
|
Help us keep Appwrite open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
|
## Submit a Pull Request 🚀
|
||||||
|
|
||||||
|
Branch naming convention is as following
|
||||||
|
|
||||||
|
`TYPE-ISSUE_ID-DESCRIPTION`
|
||||||
|
|
||||||
|
example:
|
||||||
|
```
|
||||||
|
doc-548-submit-a-pull-request-section-to-contribution-guide
|
||||||
|
```
|
||||||
|
|
||||||
|
When `TYPE` can be:
|
||||||
|
|
||||||
|
- **feat** - is a new feature
|
||||||
|
- **doc** - documentation only changes
|
||||||
|
- **cicd** - changes related to CI/CD system
|
||||||
|
- **fix** - a bug fix
|
||||||
|
- **refactor** - code change that neither fixes a bug nor adds a feature
|
||||||
|
|
||||||
|
**All PRs must include commit message with the changes description!**
|
||||||
|
|
||||||
|
For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:
|
||||||
|
|
||||||
|
1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date.
|
||||||
|
```
|
||||||
|
$ git pull
|
||||||
|
```
|
||||||
|
2. Create new branch from `master` like: `doc-548-submit-a-pull-request-section-to-contribution-guide`<br/>
|
||||||
|
```
|
||||||
|
$ git checkout -b [name_of_your_new_branch]
|
||||||
|
```
|
||||||
|
3. Work - commit - repeat ( be sure to be in your branch )
|
||||||
|
|
||||||
|
4. Push changes to GitHub
|
||||||
|
```
|
||||||
|
$ git push origin [name_of_your_new_branch]
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Submit your changes for review
|
||||||
|
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
|
||||||
|
7. Start a Pull Request
|
||||||
|
Now submit the pull request and , click on `Create pull request`.
|
||||||
|
6. Get a code review approval / reject
|
||||||
|
7. After approval, merge your PR
|
||||||
|
8. GitHub will automatically delete the branch, after the merge is done. (they can still be restored).
|
||||||
|
|
||||||
## Setup From Source
|
## Setup From Source
|
||||||
|
|
||||||
To set up a working **development environment**, just fork the project git repository and install the backend and frontend dependencies using the proper package manager and create run the docker-compose stack.
|
To set up a working **development environment**, just fork the project git repository and install the backend and frontend dependencies using the proper package manager and create run the docker-compose stack.
|
||||||
|
@ -32,6 +78,59 @@ After finishing the installation process, you can start writing and editing code
|
||||||
|
|
||||||
Appwrite's current structure is a combination of both [Monolithic](https://en.wikipedia.org/wiki/Monolithic_application) and [Microservice](https://en.wikipedia.org/wiki/Microservices) architectures, but our final goal, as we grow, is to be using only microservices.
|
Appwrite's current structure is a combination of both [Monolithic](https://en.wikipedia.org/wiki/Monolithic_application) and [Microservice](https://en.wikipedia.org/wiki/Microservices) architectures, but our final goal, as we grow, is to be using only microservices.
|
||||||
|
|
||||||
|
### File Structure
|
||||||
|
|
||||||
|
```bash
|
||||||
|
.
|
||||||
|
├── app # Main application
|
||||||
|
│ ├── config # Config files
|
||||||
|
│ ├── controllers # API & dashboard controllers
|
||||||
|
│ │ ├── api
|
||||||
|
│ │ ├── shared
|
||||||
|
│ │ └── web
|
||||||
|
│ ├── db # DB schemas
|
||||||
|
│ ├── sdks # SDKs generated copies (used for generating code examples)
|
||||||
|
│ ├── tasks # Server CLI commands
|
||||||
|
│ ├── views # HTML server-side templates
|
||||||
|
│ └── workers # Background workers
|
||||||
|
├── bin # Server executables (tasks & workers)
|
||||||
|
├── docker # Docker related resources and configs
|
||||||
|
├── docs # Docs and tutorials
|
||||||
|
│ ├── examples
|
||||||
|
│ ├── references
|
||||||
|
│ ├── sdks
|
||||||
|
│ ├── services
|
||||||
|
│ ├── specs
|
||||||
|
│ └── tutorials
|
||||||
|
├── public # Public files
|
||||||
|
│ ├── dist
|
||||||
|
│ ├── fonts
|
||||||
|
│ ├── images
|
||||||
|
│ ├── scripts
|
||||||
|
│ └── styles
|
||||||
|
├── src # Supporting libraries (each lib has one role, common libs are released as individual projects)
|
||||||
|
│ └── Appwrite
|
||||||
|
│ ├── Auth
|
||||||
|
│ ├── Database
|
||||||
|
│ ├── Docker
|
||||||
|
│ ├── Event
|
||||||
|
│ ├── Extend
|
||||||
|
│ ├── Network
|
||||||
|
│ ├── OpenSSL
|
||||||
|
│ ├── Preloader
|
||||||
|
│ ├── Resize
|
||||||
|
│ ├── Storage
|
||||||
|
│ ├── Swoole
|
||||||
|
│ ├── Task
|
||||||
|
│ ├── Template
|
||||||
|
│ ├── URL
|
||||||
|
│ └── Utopia
|
||||||
|
└── tests # End to end & unit tests
|
||||||
|
├── e2e
|
||||||
|
├── resources
|
||||||
|
└── unit
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
![Appwrite](docs/specs/overview.drawio.svg)
|
![Appwrite](docs/specs/overview.drawio.svg)
|
||||||
---
|
---
|
||||||
|
|
1
docs/tutorials/my-first-issue.md
Normal file
1
docs/tutorials/my-first-issue.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
### Thats Your Place To create Your First Issue
|
Loading…
Reference in a new issue