Skip to content

improvement of docs and add the full tests and ci/cd #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rishavmehra wants to merge 1 commit into
base: main
Choose a base branch
from
Open

improvement of docs and add the full tests and ci/cd #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Bug report
about: Create a report to help us improve
title: '[BUG] '
labels: ['bug', 'needs-triage']
assignees: ''
---

## Bug Description

A clear and concise description of what the bug is.

## Steps to Reproduce

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected Behavior

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

## Actual Behavior

A clear and concise description of what actually happened.

## Environment

- **OS**: [e.g. macOS 14.0, Ubuntu 22.04, Windows 11]
- **Node.js Version**: [e.g. 18.17.0, 20.5.0]
- **npm Version**: [e.g. 9.6.7, 10.2.4]
- **Eremos Version**: [e.g. 0.1.0, main branch]

## Additional Context

Add any other context about the problem here, such as:
- Screenshots
- Error logs
- Configuration files
- Related issues

## Checklist

- [ ] I have searched existing issues to avoid duplicates
- [ ] I have provided all required information
- [ ] I have tested with the latest version from main branch
- [ ] I have included relevant error logs or screenshots
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: Feature request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: ['enhancement', 'needs-triage']
assignees: ''
---

## Problem Statement

A clear and concise description of what problem this feature would solve. For example: "I'm always frustrated when [...]"

## Proposed Solution

A clear and concise description of what you want to happen.

## Alternative Solutions

A clear and concise description of any alternative solutions or features you've considered.

## Use Cases

Describe specific scenarios where this feature would be useful:

1. **Use Case 1**: [Description]
2. **Use Case 2**: [Description]
3. **Use Case 3**: [Description]

## Impact

- **High Impact**: This feature would significantly improve the user experience
- **Medium Impact**: This feature would be nice to have
- **Low Impact**: This feature would be a minor improvement

## Implementation Considerations

Any thoughts on how this might be implemented:
- Technical approach
- Dependencies
- Breaking changes
- Performance implications

## Additional Context

Add any other context or screenshots about the feature request here.

## Checklist

- [ ] I have searched existing issues to avoid duplicates
- [ ] I have provided a clear problem statement
- [ ] I have described the proposed solution
- [ ] I have considered alternative approaches
- [ ] I have outlined use cases and impact
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Question
about: Ask a question about the project
title: '[QUESTION] '
labels: ['question', 'needs-triage']
assignees: ''
---

## Question

A clear and concise description of your question.

## Context

Provide some context about your question:
- What are you trying to accomplish?
- What have you already tried?
- What documentation have you read?

## Code Example (if applicable)

If your question involves code, please share relevant code snippets:

```typescript
// Your code here
const agent = new ExampleAgent();
agent.observe(event);
```

## Environment

- **OS**: [e.g. macOS 14.0, Ubuntu 22.04, Windows 11]
- **Node.js Version**: [e.g. 18.17.0, 20.5.0]
- **npm Version**: [e.g. 9.6.7, 10.2.4]
- **Eremos Version**: [e.g. 0.1.0, main branch]

## Additional Information

Any other information that might be relevant to your question.

## Checklist

- [ ] I have searched existing issues and documentation
- [ ] I have provided clear context for my question
- [ ] I have included relevant code examples if applicable
- [ ] I have checked the project documentation and examples
53 changes: 53 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Fixes # (issue)

## Type of Change

Please delete options that are not relevant.

- [ ] 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
- [ ] Performance improvement
- [ ] Test addition or update
- [ ] CI/CD improvement

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

- [ ] Unit tests pass
- [ ] Integration tests pass
- [ ] Manual testing completed
- [ ] All existing tests pass

## 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
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] I have updated the CHANGELOG.md file

## Additional Notes

Add any other context about the pull request here.

## Screenshots (if applicable)

Add screenshots to help explain your changes.

## Related Issues

- Related to # (issue)
- Closes # (issue)
- Depends on # (issue)
95 changes: 95 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: CI

on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main, develop ]

jobs:
test:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [18.x, 20.x]

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Run linting
run: npm run lint

- name: Run type checking
run: npm run typecheck

- name: Run formatting check
run: npm run format:check

- name: Run tests
run: npm test

- name: Run test coverage
run: npm run test:coverage

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
file: ./coverage/lcov.info
fail_ci_if_error: false

build:
runs-on: ubuntu-latest
needs: test

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Use Node.js 20.x
uses: actions/setup-node@v4
with:
node-version: '20.x'
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Build project
run: npm run build

- name: Validate build
run: npm run validate

security:
runs-on: ubuntu-latest
needs: test

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Use Node.js 20.x
uses: actions/setup-node@v4
with:
node-version: '20.x'
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Run security audit
run: npm audit --audit-level moderate

- name: Check for outdated dependencies
run: npm outdated
Loading