Skip to content

Commit

Permalink
Merge pull request #2335 from wellwelwel/docs-3
Browse files Browse the repository at this point in the history
chore: move documentation responsibility to website
  • Loading branch information
wellwelwel authored Jan 3, 2024
2 parents 50b40a5 + d5de9e7 commit 956c7ab
Show file tree
Hide file tree
Showing 11 changed files with 17,341 additions and 17,510 deletions.
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ updates:
- package-ecosystem: "npm"
directory: "/website"
schedule:
interval: "weekly"
interval: "daily"
34 changes: 19 additions & 15 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,41 @@
[node-mysql]: https://github.com/mysqljs/mysql
[docs-contributing]: https://sidorares.github.io/node-mysql2/docs/contributing/website

# Contributing Guidelines

## Introduction

Contributions are always welcomed. You can help `node-mysql2` community in various ways. Here are our major priorities, listed in order of importance.
Contributions are always welcomed. You can help **MySQL2** community in various ways. Here are our major priorities, listed in order of importance:

- `node-mysql` API incompatibility fixes
- Documentation
- Adding tests or improving existing ones
- Improving benchmarks
- Bug Fixes
- TODO from source
- Performance improvements
- Add Features
- [Node MySQL][node-mysql] API incompatibility fixes
- [Documentation][docs-contributing]
- Adding tests or improving existing ones
- Improving benchmarks
- Bug Fixes
- TODO from source
- Performance improvements
- Add Features

## Security Issues

Please contact project maintainers privately before opening a security issue on Github. It will allow us to fix the issue before attackers know about it.

**Contact**
### Contact

- Andrey Sidorov, [email protected]

## New Features

Its better to discuss an API before actually start implementing it. You can open an issue on Github. We can discuss design of API and implementation ideas.
It's better to discuss an API before actually start implementing it. You can open an issue on Github. We can discuss design of API and implementation ideas.

## Development

We assume you already have these tools installed on your system
- MySQL Server
- Node.JS
We assume you already have these tools installed on your system:

- MySQL Server
- Node.JS

As `node-mysql2` is purely JS based you can develop it on Linux, Mac or Windows. Please follow these steps
As **MySQL2** is purely JS based you can develop it on Linux, Mac or Windows. Please follow these steps

```bash
# clone node-mysql2
Expand Down
Loading

0 comments on commit 956c7ab

Please sign in to comment.