Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: move documentation responsibility to website #2335

Merged
merged 4 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading