github-actions[bot]
e3757f300a
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
79 lines
1.7 KiB
Plaintext
79 lines
1.7 KiB
Plaintext
---
|
|
title: Bugs, Requests & Pull Requests
|
|
info: Report issues, request features, and contribute code
|
|
---
|
|
|
|
## Reporting Bugs
|
|
|
|
To report a bug, please [create an issue on GitHub](https://github.com/twentyhq/twenty/issues/new).
|
|
|
|
You can also ask for help on [Discord](https://discord.gg/cx5n4Jzs57).
|
|
|
|
## Feature Requests
|
|
|
|
If you're not sure if it's a bug, and you feel it's closer to a feature request, then you should probably [open a discussion instead](https://github.com/twentyhq/twenty/discussions/new).
|
|
|
|
## Submit a Pull Request
|
|
|
|
Contributing code to Twenty starts with a pull request (PR).
|
|
|
|
### Before You Start
|
|
|
|
1. Check [existing issues](https://github.com/twentyhq/twenty/issues) for related work
|
|
2. For new features, open an issue first to discuss
|
|
3. Review our [Code of Conduct](https://github.com/twentyhq/twenty/blob/main/CODE_OF_CONDUCT.md)
|
|
|
|
### Fork and Clone
|
|
|
|
1. Fork the repository on GitHub
|
|
2. Clone your fork:
|
|
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/twenty.git
|
|
cd twenty
|
|
```
|
|
|
|
3. Add upstream remote:
|
|
|
|
```bash
|
|
git remote add upstream https://github.com/twentyhq/twenty.git
|
|
```
|
|
|
|
### Create a Branch
|
|
|
|
```bash
|
|
git checkout -b feature/your-feature-name
|
|
```
|
|
|
|
Use descriptive branch names:
|
|
|
|
* `feature/add-export-button`
|
|
* `fix/login-redirect-issue`
|
|
* `docs/update-api-guide`
|
|
|
|
### Make Your Changes
|
|
|
|
1. Write clean, well-documented code
|
|
2. Follow existing code style
|
|
3. Add tests for new functionality
|
|
4. Update documentation if needed
|
|
|
|
### Submit Your PR
|
|
|
|
1. Push your branch:
|
|
|
|
```bash
|
|
git push origin feature/your-feature-name
|
|
```
|
|
|
|
2. Open a PR on GitHub
|
|
3. Fill in the PR template
|
|
4. Link related issues
|
|
|
|
### PR Checklist
|
|
|
|
* [ ] Code follows project style guidelines
|
|
* [ ] Tests pass locally
|
|
* [ ] Documentation is updated
|
|
* [ ] PR description explains the changes
|