mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-21 21:47:17 +00:00
d1bd60b8ac
* Accessibility for README Add accessibility features to markdown file based on: https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/ * Accessibility for CODE_OF_CONDUCT Accessibility for markdowns, based on: https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/ * Some accessibility, some typography * Fix email link
54 lines
2.7 KiB
Markdown
54 lines
2.7 KiB
Markdown
# Contributing to ToolJet
|
|
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
|
|
|
|
- Reporting a bug
|
|
- Discussing the current state of the code
|
|
- Submitting a fix
|
|
- Proposing new features
|
|
|
|
## Setup
|
|
|
|
- [Mac OS](https://docs.tooljet.io/docs/contributing-guide/setup/macos)
|
|
- [Docker](https://docs.tooljet.io/docs/contributing-guide/setup/docker)
|
|
- [Ubuntu](https://docs.tooljet.io/docs/contributing-guide/setup/ubuntu)
|
|
|
|
## We Develop with GitHub
|
|
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
|
|
|
|
## First-time contributors
|
|
We've tagged some issues to make it easy to get started :smile:
|
|
[Good first issues](https://github.com/ToolJet/ToolJet/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
|
|
|
If you're interested in working on an issue, make sure it has either a `good-first-issue` or `up-for-grabs` label added. Add a comment on the issue and wait for the issue to be assigned before you start working on it. This helps to avoid multiple people working on similar issues.
|
|
|
|
## We Use [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests
|
|
Pull requests are the best way to propose changes to the codebase (we use [Git-Flow](https://nvie.com/posts/a-successful-git-branching-model/)). We actively welcome your pull requests:
|
|
|
|
1. Fork the repo and create your branch from `develop`. Please create the branch in the format feature/<issue-id>-<issue-name> (eg: feature/176-chart-widget)
|
|
2. If you've added code that should be tested, add tests.
|
|
3. If you've changed APIs, update the documentation.
|
|
4. Ensure the test suite passes.
|
|
5. Make sure your code lints.
|
|
6. Issue that pull request!
|
|
|
|
## Any contributions you make will be under the AGPL v3 License
|
|
In short, when you submit code changes, your submissions are understood to be under the same [AGPL v3 License](https://www.gnu.org/licenses/agpl-3.0.en.html) that covers the project.
|
|
|
|
## Report bugs using GitHub's [issues](https://github.com/ToolJet/ToolJet/issues)
|
|
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/ToolJet/ToolJet/issues/new/choose). It's that easy!
|
|
|
|
**Great Bug Reports** tend to have:
|
|
|
|
- A quick summary and/or background
|
|
- Steps to reproduce
|
|
- Be specific!
|
|
- Give sample code if you can.
|
|
- What you expected would happen
|
|
- What actually happens
|
|
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
|
|
|
|
## License
|
|
By contributing, you agree that your contributions will be licensed under its AGPL v3 License.
|
|
|
|
## Questions?
|
|
Contact us [on Slack](https://tooljet.com/slack) or [email us at hello@tooljet.io](mailto:hello@tooljet.io).
|