57 lines
No EOL
1.8 KiB
Markdown
57 lines
No EOL
1.8 KiB
Markdown
# Contributing to WWebJS REST API Wrapper
|
|
|
|
Welcome to WWebJS API Wrapper! We appreciate your interest in contributing to this project. Please follow the guidelines below to contribute effectively.
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository.
|
|
2. Clone your forked repository to your local machine.
|
|
3. Install the necessary dependencies by running `npm install`.
|
|
4. Create a new branch for your contribution.
|
|
|
|
## Code Style
|
|
|
|
- Follow the existing code style and conventions in the project.
|
|
- Use meaningful variable and function names.
|
|
- Add comments to your code, especially for complex or tricky parts.
|
|
|
|
## Pull Requests
|
|
|
|
- Create a pull request from your branch to the `main` branch of this repository.
|
|
- Provide a clear and descriptive title for your pull request.
|
|
- Include a detailed description of the changes you made in the pull request.
|
|
- Reference any related issues in your pull request description using the `#` symbol followed by the issue number.
|
|
|
|
## Testing
|
|
|
|
- Write appropriate unit tests for your code.
|
|
- Make sure all existing tests pass.
|
|
- Provide instructions for testing your changes, if necessary.
|
|
|
|
## Documentation
|
|
|
|
- Update the README.md file with any relevant information about your contribution, including installation instructions, usage examples, and API documentation.
|
|
|
|
## Code Block Example
|
|
|
|
When providing code examples or error messages, please use code blocks. You can create a code block by wrapping your code or message with triple backticks (\```) on separate lines, like this:
|
|
|
|
\```
|
|
// Example code block
|
|
const hello = "Hello, world!";
|
|
console.log(hello);
|
|
\```
|
|
|
|
This will render as:
|
|
|
|
```
|
|
// Example code block
|
|
const hello = "Hello, world!";
|
|
console.log(hello);
|
|
```
|
|
|
|
## Contact Us
|
|
|
|
If you have any questions or need further assistance, feel free to contact us by opening an issue or reaching out to us through email or chat.
|
|
|
|
Thank you for your contribution! |