|
| 1 | +# Contributing to Manus-JS |
| 2 | + |
| 3 | +[](https://github.com/duongnguyen321/manus-js/graphs/contributors) |
| 4 | +[](https://github.com/duongnguyen321/manus-js/issues) |
| 5 | +[](https://github.com/duongnguyen321/manus-js/pulls) |
| 6 | + |
| 7 | +Thank you for considering contributing to Manus-JS! This document provides guidelines and instructions for contributing to this project. |
| 8 | + |
| 9 | +## How Can I Contribute? |
| 10 | + |
| 11 | +### Reporting Bugs |
| 12 | + |
| 13 | +Before creating bug reports, please check the [issue list](https://github.com/duongnguyen321/manus-js/issues) as you might find that the bug has already been reported. If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/duongnguyen321/manus-js/issues/new). |
| 14 | + |
| 15 | +**Bug Report Template:** |
| 16 | +``` |
| 17 | +**Description:** |
| 18 | +[Clear and concise description of the bug] |
| 19 | +
|
| 20 | +**Steps to Reproduce:** |
| 21 | +1. [First Step] |
| 22 | +2. [Second Step] |
| 23 | +3. [and so on...] |
| 24 | +
|
| 25 | +**Expected behavior:** |
| 26 | +[What you expected to happen] |
| 27 | +
|
| 28 | +**Actual behavior:** |
| 29 | +[What actually happened] |
| 30 | +
|
| 31 | +**Environment:** |
| 32 | +- OS: [e.g. Windows 10, macOS 11.2] |
| 33 | +- Node version: [e.g. 16.13.0] |
| 34 | +- npm/yarn version: [e.g. npm 8.1.0] |
| 35 | +``` |
| 36 | + |
| 37 | +### Suggesting Enhancements |
| 38 | + |
| 39 | +Enhancement suggestions are tracked as [GitHub issues](https://github.com/duongnguyen321/manus-js/issues). Create an issue and provide the following information: |
| 40 | + |
| 41 | +- **Use a clear and descriptive title** |
| 42 | +- **Provide a detailed description of the suggested enhancement** |
| 43 | +- **Explain why this enhancement would be useful** |
| 44 | +- **List any relevant examples if applicable** |
| 45 | + |
| 46 | +### Pull Requests |
| 47 | + |
| 48 | +1. Fork the repo and create your branch from `main` |
| 49 | +2. If you've added code that should be tested, add tests |
| 50 | +3. If you've changed APIs, update the documentation |
| 51 | +4. Ensure the test suite passes |
| 52 | +5. Make sure your code follows the existing style guidelines |
| 53 | +6. Submit your pull request! |
| 54 | + |
| 55 | +## Development Setup |
| 56 | + |
| 57 | +1. Clone the repository: |
| 58 | + ```bash |
| 59 | + git clone https://github.com/duongnguyen321/manus-js.git |
| 60 | + cd manus-js |
| 61 | + ``` |
| 62 | + |
| 63 | +2. Install dependencies: |
| 64 | + ```bash |
| 65 | + bun install |
| 66 | + # or |
| 67 | + npm install |
| 68 | + # or |
| 69 | + yarn install |
| 70 | + ``` |
| 71 | + |
| 72 | +3. Create a branch for your changes: |
| 73 | + ```bash |
| 74 | + git checkout -b feature/your-feature-name |
| 75 | + ``` |
| 76 | + |
| 77 | +## Coding Guidelines |
| 78 | + |
| 79 | +### JavaScript/TypeScript Style |
| 80 | + |
| 81 | +- Use ES6+ features when appropriate |
| 82 | +- Follow the ESLint configuration in the project |
| 83 | +- Write meaningful variable and function names |
| 84 | +- Document complex logic with comments |
| 85 | +- Use TypeScript types appropriately |
| 86 | + |
| 87 | +### Commit Messages |
| 88 | + |
| 89 | +- Use the present tense ("Add feature" not "Added feature") |
| 90 | +- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") |
| 91 | +- Limit the first line to 72 characters or less |
| 92 | +- Reference issues and pull requests liberally after the first line |
| 93 | + |
| 94 | +## Testing |
| 95 | + |
| 96 | +Ensure that all tests pass before submitting your PR: |
| 97 | + |
| 98 | +```bash |
| 99 | +bun run test |
| 100 | +# or |
| 101 | +npm test |
| 102 | +# or |
| 103 | +yarn test |
| 104 | +``` |
| 105 | + |
| 106 | +If you add new functionality, please include appropriate tests. |
| 107 | + |
| 108 | +## Documentation |
| 109 | + |
| 110 | +If your changes require documentation updates, please include them in your PR. |
| 111 | + |
| 112 | +## Community |
| 113 | + |
| 114 | +- Check out the [project](https://github.com/duongnguyen321/manus-js) |
| 115 | + |
| 116 | +## Attribution |
| 117 | + |
| 118 | +Contributors will be acknowledged in our [README.md](README.md). |
| 119 | + |
| 120 | +--- |
| 121 | + |
| 122 | +Thank you for contributing to Manus-JS! 🚀 |
0 commit comments