Adding Github workflow for pull requests and also referencing contributing.md in README (#417)
This commit is contained in:
parent
60393ba29c
commit
f4debb3c69
|
|
@ -21,6 +21,18 @@ There are many ways in which we/one can to contribute to Appsmith. All contribut
|
|||
- Widgets
|
||||
- Datasources
|
||||
|
||||
## Git Workflow
|
||||
|
||||
We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests.
|
||||
|
||||
Pull requests are the best way to propose changes to the codebase and get them reviewed by maintainers.
|
||||
|
||||
1. Fork the repo and create your branch from `release`.
|
||||
2. If you've added code that should be tested, add tests. If it's a client-side change, tests must be added via Cypress/Jest. For server-side changes, please add JUnit tests.
|
||||
3. If you've changed any APIs, please call this out in the pull request. Also, don't forget to add/modify integration tests via Cypress to ensure that changes are backwards compatible.
|
||||
4. At all times, ensure the test suite passes. We will not be able to accept your change if the test suite doesn't pass.
|
||||
5. Create an issue referencing the pull request. This ensures that we can track the bug being fixed or feature being added easily.
|
||||
|
||||
|
||||
## 👨💻 How to set up local development
|
||||
|
||||
|
|
|
|||
|
|
@ -73,6 +73,10 @@ If you have encountered a bug or need to get in touch with us, you can contact u
|
|||
|
||||
We are committed to fostering an open and welcoming environment in the community. Please see the [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
## Contributing to Appsmith
|
||||
|
||||
Please read our [contribution guidelines](https://github.com/appsmithorg/appsmith/blob/master/CONTRIBUTING.md) in order to contribute to Appsmith.
|
||||
|
||||
## License
|
||||
|
||||
The Appsmith platform is available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) (Apache-2.0).
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user