cf650f8ad0
* Update IssuesReport.md * Update IssuesReport.md * Create ClientSetup.md * Update ClientSetup.md * Update ClientSetup.md * Update ClientSetup.md * Create ServerSetup.md * Update ClientSetup.md * Create CodeContributionsGuidelines.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CodeContributionsGuidelines.md * Update IssuesReport.md * Update CodeContributionsGuidelines.md * Update CONTRIBUTING.md * Update IssuesReport.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update ClientSetup.md * Update ClientSetup.md Co-authored-by: Nikhil <nikhil@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com>
47 lines
3.3 KiB
Markdown
47 lines
3.3 KiB
Markdown
# Contributing to Appsmith
|
|
|
|
Thank you for your interest in Appsmith and taking the time to contribute on this project. 🙌
|
|
Appsmith is a project by developers for developers and there are a lot of ways you can contribute.
|
|
Feel free to propose changes to this document in a pull request.
|
|
|
|
## Code of conduct
|
|
|
|
Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing
|
|
|
|
## How can I contribute?
|
|
|
|
There are many ways in which we/one can to contribute to Appsmith. All contributions are highly appreciated.
|
|
|
|
#### 🐛 Report a bug
|
|
Report all issues through GitHub Issues using the [Report a Bug](https://github.com/appsmithorg/appsmith/issues/new?assignees=Nikhil-Nandagopal&labels=Bug%2C+High&template=---bug-report.md&title=%5BBug%5D) template.
|
|
To help resolve your issue as quickly as possible, read the template and provide all the requested information.
|
|
|
|
#### 🛠 File a feature request
|
|
We welcome all feature requests, whether it's to add new functionality to an existing extension or to offer an idea for a brand new extension.
|
|
File your feature request through GitHub Issues using the [Feature Request](https://github.com/appsmithorg/appsmith/issues/new?assignees=Nikhil-Nandagopal&labels=&template=----feature-request.md&title=%5BFeature%5D) template.
|
|
|
|
#### 📝 Improve the documentation
|
|
In the process of shipping features quickly, we often forget to keep our [Documentation](https://docs.appsmith.com) up to date. You can help by suggesting improvements to our documentation. Read our [Documentation Contribution Guide]()
|
|
|
|
#### 💥 Fix a bug
|
|
We welcome contributions that help make appsmith bug free. Check our [good first issues](https://github.com/appsmithorg/appsmith/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22+label%3A%22Bug%22) & [begin contributing](#code-contribution)
|
|
|
|
#### ⚙️ Build a feature
|
|
Being a horizontal platform, we have a never ending list of [feature requests](https://github.com/appsmithorg/appsmith/issues?q=is%3Aopen+is%3Aissue+label%3AEnhancement) that you can contribute to. Get started with our [contribution section](#code-contribution)
|
|
|
|
## Code Contribution
|
|
All Code contributions are welcome and highly encouraged. Before opening a PR, create an issue and talk to a maintainer about a possible solution.
|
|
This ensures that your PR has the highest chance of getting merged quickly and avoids 2 contributors from working on the same issue.
|
|
|
|
### Contributing to the Frontend (React / HTML / CSS / JS)
|
|
- Go through our list of frontend [good first issues](https://github.com/appsmithorg/appsmith/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22+label%3A%22Frontend%22)
|
|
- Pick the ones you like most and drop us a comment!
|
|
- [Run the codebase](contributions/ClientSetup.md) on your local machine
|
|
- Follow our [Code Contribution Guide](contributions/CodeContributionsGuidelines.md) and raise your first PR!
|
|
|
|
### Contributing to the Backend (Java / Mongo / Springboot)
|
|
- Go through our list of backend [good first issues](https://github.com/appsmithorg/appsmith/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22+label%3A%22Backend%22+)
|
|
- Pick the ones you like most and drop us a comment!
|
|
- [Run the codebase](contributions/ServerSetup.md) on your local machine
|
|
- Follow our [Code Contribution Guide](contributions/CodeContributionsGuidelines.md) and raise your first PR!
|