Commit Graph

15 Commits

Author SHA1 Message Date
Somangshu Goswami
846556bb7e
Chore/update contribution guideline (#34307)
## Description

this is a change in the contribution guideline. 
1. it informs external contributors of the best practices. 
2. it updates some outdated pieces. 



## Automation

/ok-to-test tags=""

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!CAUTION]  
> If you modify the content in this section, you are likely to disrupt
the CI result for your PR.

<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [x] Yes - probably because this relates to them?
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
  - Updated contribution guidelines to include:
    - Requirement to inform maintainers before working on issues.
    - Branch naming conventions.
    - Proper PR descriptions and including tests.
- Instructions to tag maintainers when raising a PR and handle requested
changes.
- Emphasis on collaborating with maintainers and reviewers to avoid
rejected contributions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-06-18 17:43:30 +05:30
Shrikant Sharat Kandula
a6609e7631
chore: Switch to gitleaks from git-secrets (#29103)
The `gitleaks` project provides a more out-of-the-box experience and is
able to find more than AWS keys in the files.
2023-11-28 06:32:20 +05:30
Ayush Kumar Bhadani
92a60f775f
chore: fixed the error sentence in the contribution guideline doc (#23036) 2023-05-11 10:59:19 +05:30
Ayush Pahwa
4217acbcc4
feat: prevent secrets to be pushed to repo (#15259)
## Description

Currently, our repository is prone to any dev pushing secrets to the repository by mistake. This can become a major problem very quickly and in the case of services like AWS, an alarm is raised and the key is deactivated causing apps using the key to break.

After this PR is merged, people will need to have [git secrets](https://github.com/awslabs/git-secrets) installed in their systems and have to register the AWS secrets to the repo.

The setup instructions have been mentioned [here](https://www.notion.so/appsmith/Getting-Started-e81ccc35463343b28e09c200cdbe5f42#c3183e8e6e404701920dd288b8506360)

Notes: 
1. right now, since we are using the pre-commit hooks using husky, the hooks work when we have done yarn install. 
2. Also, the scan only checks the directory we are in while making the change or raising the PR. This is because it uses `git ls-files` to get the list of files to scan.
3. If someone doesn't run `git-secrets --register-aws`, the tests will pass automatically since there is no regex registered with the system to scan against.

Fixes #15042

## Type of change

- New feature (non-breaking change which adds functionality)

## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
2022-07-20 20:35:18 +05:30
Abhinav Jha
1bd549029b
docs: widget development contribution guide (#9292)
* Add widget development guide in contribution guidelines

* Add link to the widget development guidelines

* Fix formatting issue w.r.t to indentation and images

* A few more missed fixes

* Embed video and indent arguments correctly:

* Fix relative paths

* Fix indentation in Blueprint view
2021-11-23 14:55:47 +05:30
Pranay
b72b963806
docs: Updating contribution guides (#7763) 2021-09-24 14:14:34 +05:30
Hetu Nandu
f50dfd308b
[Docs] Custom JS library contribution (#5583)
* Create CustomJsLibrary.md

* Moving the files to appropriate folders

Co-authored-by: Arpit Mohan <arpit@appsmith.com>
2021-07-06 14:16:56 +05:30
Sumit Kumar
134f1a9c43
Plugin code contribution guidelines file. (#2324)
1. Provide guidelines to help external contributors add new plugins.
2020-12-29 13:09:44 +05:30
Rishabh Saxena
630a1ae9e4
Add steps for running cypress tests in code contribution guidelines (#2056) 2020-12-07 20:11:51 +05:30
Arpit Mohan
7c3a8c0de9
Modifying the release endpoint in docs (#1791)
* Modifying the release endpoint in docs

* Adding reference to Test contribution guide in docs
2020-11-19 09:07:25 +05:30
Nikhil Nandagopal
92d0fcac82
Update CodeContributionsGuidelines.md 2020-10-08 16:24:52 +05:30
Nikhil Nandagopal
97be86f479
Update CodeContributionsGuidelines.md 2020-10-01 19:48:17 +05:30
Nikhil Nandagopal
01c5118be6
Update CodeContributionsGuidelines.md 2020-09-30 23:56:07 +05:30
Nikhil Nandagopal
7b538f86fc
Update CodeContributionsGuidelines.md 2020-09-30 23:27:19 +05:30
Nikhil Nandagopal
cf650f8ad0
Feature/hacktoberfest (#841)
* 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>
2020-09-30 23:23:10 +05:30