-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: separate documentation in multiple files (#100)
* docs: add CONTRIBUTING.md * docs: move full documentation * docs: change base readme file * docs: fix callouts * docs: move donate label * docs: add info in donate * docs: add other doc link
- Loading branch information
1 parent
8cf94f2
commit 661301d
Showing
3 changed files
with
804 additions
and
599 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
# Contributing to Directus Sync | ||
|
||
First off, thanks for taking the time to contribute! 🚀 | ||
We appreciate your interest in improving **Directus Sync**, and we welcome contributions of all kinds. | ||
|
||
## Table of Contents | ||
|
||
- [How Can I Contribute?](#how-can-i-contribute) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Feature Requests](#feature-requests) | ||
- [Code Contributions](#code-contributions) | ||
- [Development Workflow](#development-workflow) | ||
- [Setting Up the Environment](#setting-up-the-environment) | ||
- [Submitting Changes](#submitting-changes) | ||
- [Coding Guidelines](#coding-guidelines) | ||
- [Style Guide](#style-guide) | ||
- [Code of Conduct](#code-of-conduct) | ||
|
||
--- | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
If you find a bug in **Directus Sync**, please create an issue on | ||
the [issue tracker](https://github.com/tractr/directus-sync/issues). Ensure that your bug report contains the following | ||
details: | ||
|
||
- A clear and descriptive title. | ||
- Steps to reproduce the issue. | ||
- The expected and actual behavior. | ||
- Any relevant logs or screenshots. | ||
|
||
### Feature Requests | ||
|
||
We're open to new ideas! If you have a feature request, please open an issue on GitHub using the `[Feature Request]` | ||
tag. Provide a detailed explanation of the feature and its potential impact. | ||
|
||
### Code Contributions | ||
|
||
We welcome pull requests (PRs) for bug fixes, features, and documentation improvements. | ||
Before submitting a PR, please make sure it adheres to the guidelines mentioned below. | ||
|
||
## Development Workflow | ||
|
||
### Setting Up the Environment | ||
|
||
1. **Clone the repository**: | ||
```bash | ||
git clone https://github.com/tractr/directus-sync.git | ||
cd directus-sync | ||
``` | ||
|
||
2. **Install dependencies**: | ||
```bash | ||
npm install | ||
``` | ||
|
||
3. **Run tests**: | ||
Make sure to run tests before submitting a PR to ensure that your code doesn't break existing functionality. | ||
```bash | ||
npm test | ||
``` | ||
|
||
### Submitting Changes | ||
|
||
- Fork the repository and create a new branch for your feature or fix. | ||
- Write clear and descriptive commit messages. | ||
- Make sure your code is properly tested. | ||
- Open a pull request on the `main` branch with a description of your changes. | ||
- Ensure your PR passes CI checks. | ||
|
||
## Coding Guidelines | ||
|
||
- **TypeScript**: Ensure your code is strongly typed. | ||
- **Error Handling**: Handle errors gracefully and avoid crashing the CLI. | ||
- **Logging**: Use consistent logging practices, providing useful output for debugging purposes. | ||
|
||
## Style Guide | ||
|
||
- Use [Prettier](https://prettier.io/) to format your code. | ||
```bash | ||
npm run format | ||
``` | ||
- Use [ESLint](https://eslint.org/) to lint your code. | ||
```bash | ||
npm run lint | ||
``` | ||
- Follow consistent naming conventions. | ||
- Write meaningful comments, especially for complex logic. | ||
|
||
## Code of Conduct | ||
|
||
This project follows a [Code of Conduct](https://github.com/tractr/directus-sync/blob/main/CODE_OF_CONDUCT.md) to create | ||
a welcoming environment for everyone. Please read it before contributing. | ||
|
||
--- | ||
|
||
Thank you for contributing to **Directus Sync**! ✨ |
Oops, something went wrong.