Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: bug
# assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Apex script to reproduce the behavior:

```java
// code here
```

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: enhancement
# assignees: ''
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

```java
// code here
```

**Additional context**
Add any other context or screenshots about the feature request here.
61 changes: 61 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## Description

<!-- Provide a clear and concise description of your changes -->

## Type of Change

<!-- Mark the relevant option with an 'x' -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Test improvements
- [ ] CI/CD improvements

## Changes Made

<!-- List the specific changes made in this PR -->

-
-
-

## Related Issues

<!-- Link to related issues using #issue_number -->

Fixes #
Closes #

## Testing

<!-- Describe the tests you ran to verify your changes -->

- [ ] All existing tests pass (`npm test`)
- [ ] Added new tests for new functionality
- [ ] Tested in scratch org
- [ ] Linting passes (`npm run lint`)
- [ ] Code formatting is correct (`npm run prettier:verify`)

## Screenshots

<!-- If applicable, add screenshots to help explain your changes -->

## Checklist

<!-- Mark completed items with an 'x' -->

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code where necessary
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings or errors
- [ ] 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
- [ ] Any dependent changes have been merged and published

## Additional Notes

<!-- Add any additional information that reviewers should know -->
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ $RECYCLE.BIN/

#Private keys
*.key
website/docs/.vitepress/dist
website/docs/.vitepress/cache
drafts

# VitePress cache
website/.vitepress/cache/
website/.vitepress/dist/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<div align="center">
<a href="https://dml.beyondthecloud.dev">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./website/docs/public/DML-lib-logo.png">
<img alt="SOQL Lib logo" src="./website/docs/public/DML-lib-logo.png" height="98">
<source media="(prefers-color-scheme: dark)" srcset="./website/public/logo.png">
<img alt="DML Lib logo" src="./website/public/logo.png" height="98">
</picture>
</a>
<h1>DML Lib</h1>
Expand Down
86 changes: 85 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,91 @@

## Supported Versions

This template is actively maintained and we recommend always using the latest version.

| Version | Supported |
| ------- | ------------------ |
| 1.8.x | :white_check_mark: |
| 1.7.x | :white_check_mark: |
| 1.7.x | :white_check_mark: |

## Reporting a Vulnerability

If you discover a security vulnerability in this Salesforce template, please report it responsibly.

### How to Report

**DO NOT** create a public GitHub issue for security vulnerabilities.

Instead, please report security issues via email to:

📧 **[email protected]**

### What to Include

When reporting a vulnerability, please include:

- Description of the vulnerability
- Steps to reproduce the issue
- Potential impact
- Suggested fix (if you have one)
- Your contact information

### Response Timeline

- We will acknowledge receipt of your vulnerability report within **3 business days**
- We will provide a more detailed response within **7 business days**
- We will work with you to understand and address the issue
- We will notify you when the vulnerability has been fixed

### Responsible Disclosure

We appreciate responsible disclosure and will:

- Keep you informed about our progress
- Credit you in the fix (if you wish)
- Work to address the issue as quickly as possible

## Security Best Practices

When using this template:

### Salesforce Security

- **Never commit credentials** - Use `.gitignore` for sensitive files
- **Use scratch org URLs** - Rotate Dev Hub auth URLs regularly
- **Review permissions** - Implement proper sharing and FLS checks
- **Validate input** - Prevent SOQL injection and XSS
- **Use secrets management** - Store GitHub secrets securely

### Code Quality

- Run security checks: `npm run lint`
- Review dependencies: `npm audit`
- Keep dependencies updated: `npm update`
- Use pre-commit hooks (Husky)

### CI/CD Security

- **Protect GitHub secrets** - Limit access to `SFDX_AUTH_URL_DEVHUB`
- **Branch protection** - Enable branch protection on `main`
- **Review workflows** - Audit GitHub Actions regularly
- **Limit permissions** - Use minimal required permissions

## Security Resources

- [Salesforce Security Guide](https://developer.salesforce.com/docs/atlas.en-us.secure_coding_guide.meta/secure_coding_guide/)
- [OWASP Top 10](https://owasp.org/www-project-top-ten/)
- [GitHub Security Best Practices](https://docs.github.com/en/code-security)

## Contact

For security concerns, contact:

**Beyond The Cloud Sp. z o.o.**

- Email: [email protected]
- Website: [beyondthecloud.dev](https://beyondthecloud.dev)

---

Thank you for helping keep this template and its users safe! 🔒
Loading