Skip to content

Commit

Permalink
update readme and contributing md
Browse files Browse the repository at this point in the history
  • Loading branch information
TGlide committed Aug 4, 2023
1 parent a4eaaf0 commit 1721ed8
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 6 deletions.
23 changes: 17 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ 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
- **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 a commit message with a description of the changes made!**

Expand Down Expand Up @@ -103,6 +103,17 @@ Please avoid introducing new dependencies to Appwrite without consulting the tea

Adding a new dependency should contribute vital value to the product with minimum possible risk.

## Updating the Documentation

We created a python script, located at `scrape.py`, that fetches various links in the Appwrite documentation, and saves them to JSON files in the `docs` folder. To run the script, execute the following command.

```bash
python3 -m pip install -r requirements.txt
python3 scrape.py
```

To update the documentation, you can change which files are fetched by editing the `scrape.py` file.

## Introducing New Features

We would 💖 you to contribute to Appwrite, but we also want to ensure Appwrite is loyal to its vision and mission statement 🙏.
Expand Down Expand Up @@ -143,4 +154,4 @@ You can also help by teaching others how to contribute to Appwrite's repo! Pleas

## Code of Conduct

Help us keep Appwrite open and inclusive. Please read and follow our [Code of Conduct](https://github.com/appwrite/.github/blob/main/CODE_OF_CONDUCT.md).
Help us keep Appwrite open and inclusive. Please read and follow our [Code of Conduct](https://github.com/appwrite/.github/blob/main/CODE_OF_CONDUCT.md).
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Assistant ✨

[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
[![appwrite.io](https://img.shields.io/badge/appwrite-.io-f02e65?style=flat-square)](https://appwrite.io)

Appwrite Assistant is an AI-powered API that helps you with Appwrite-related tasks, powered by the official Appwrite documentation.

## Installation

Make sure you have [pnpm](https://pnpm.io/) installed.

To install, run the following command.

```bash
pnpm i
```

## Usage

To run the server, execute the `main.js` file with node, or run the `dev` command to hot-restart the server on file changes.

```bash
node main.js
# Or
pnpm run dev
```

## Contributing

All code contributions, including those of people having commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](CONTRIBUTING.md).

0 comments on commit 1721ed8

Please sign in to comment.