Skip to content
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.

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

chore: implement repository standards and templates #26

Merged
merged 3 commits into from
Jan 26, 2025
Merged
Show file tree
Hide file tree
Changes from 2 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
Binary file removed .DS_Store
Binary file not shown.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!-- Title should follow conventional commits format, e.g.: -->
<!-- feat: add new payment method support -->
<!-- fix: resolve transaction timeout issue -->
<!-- docs: update API integration guide -->

### Description
A clear and concise description of the issue or feature request.

### Current Behavior
<!-- For bugs -->
A clear description of what currently happens. Include error messages or screenshots if applicable.

<!-- For features -->
Describe current limitations or why this feature would be beneficial.

### Expected Behavior
A clear description of what you expected to happen.

### Reproduction Steps
<!-- For bugs - remove for feature requests -->
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Context
<!-- Any additional context that might be helpful -->
- Browser/Environment: [e.g. Chrome 120, Node 18]
- Package Version: [e.g. v1.2.0]
- Related Issues: #123, #456

### Proposed Solution
<!-- Optional - If you have ideas on how to implement this -->
Your suggestions for implementing the solution or fixing the bug.

### Acceptance Criteria
<!-- What needs to be done for this issue to be resolved -->
- [ ] Criteria 1
- [ ] Criteria 2
- [ ] Tests added/updated
- [ ] Documentation updated

### Additional Information
Any other information that might be relevant to the issue.

<!-- Remove sections that aren't relevant to your issue -->
53 changes: 53 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!-- PR title should follow conventional commits format -->
<!-- feat: implement new payment processing flow -->
<!-- fix: resolve transaction validation error -->
<!-- refactor: consolidate payment gateway services -->

### Description
<!-- Provide context for reviewers -->
A clear and concise description of what this PR implements or fixes.

Related issue: #123

### Changes Made
<!-- List the key changes in this PR -->
- Implemented X
- Updated Y
- Fixed Z

### Type of Change
<!-- Mark relevant items with an x -->
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement

### Testing
<!-- Describe the testing you've done -->
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing performed

### Test Instructions
<!-- How can reviewers test your changes? -->
1. Checkout branch
2. Run `pnpm install`
3. Additional steps...

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

### Checklist
<!-- Mark completed items with an x -->
- [ ] My code follows the project's coding style
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have updated the documentation accordingly
- [ ] My changes generate no new warnings
- [ ] New and existing unit tests pass locally
- [ ] I have added tests that prove my fix/feature works
- [ ] Any dependent changes have been merged and published

### Additional Notes
<!-- Any other information that would be helpful to reviewers -->
43 changes: 43 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# dependencies
node_modules
.pnp
.pnp.js

# testing
coverage

# next.js
.next/
out/
build

# other
dist/

# misc
.DS_Store
*.pem

# cookies
cookies/
cookies

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# local env files
.env
.env.*
.env.local
.env.development.local
.env.test.local
.env.production.local

# logs
logs/

# turbo
.turbo
68 changes: 68 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
### Contributor Covenant Code of Conduct

#### Our Pledge

We as members, contributors, and maintainers pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

#### Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

#### Enforcement Responsibilities

Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. They will communicate reasons for moderation decisions when appropriate.

#### Scope

This Code of Conduct applies within all project spaces and also applies when an individual is officially representing the project in public spaces. Examples of representing the project include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

#### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the maintainers responsible for enforcement. While a dedicated email address is forthcoming, reporters may contact the maintainers using their public contact information available on their GitHub profiles.

All complaints will be reviewed and investigated promptly and fairly. Maintainers are obligated to respect the privacy and security of the reporter of any incident.

#### Enforcement Guidelines

Maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

**1. Correction**
- Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
- Consequence: A private, written warning from the maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

**2. Warning**
- Community Impact: A violation through a single incident or series of actions.
- Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

**3. Temporary Ban**
- Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
- Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

**4. Permanent Ban**
- Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
- Consequence: A permanent ban from any sort of public interaction within the community.

#### Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).

104 changes: 104 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Contributing to Strapex

Thank you for your interest in contributing to Strapex! We aim to make blockchain payments accessible and secure, and we appreciate your help in achieving this goal.

## Getting Started

1. **Fork the repository** by clicking the [Fork](https://github.com/strapexlabs/strapex/fork) button.

2. **Clone your fork**:
```bash
git clone https://github.com/your-username/strapex.git
cd strapex
```

3. **Install dependencies**:
```bash
pnpm install
```

## Development Workflow

1. **Create a new branch**:
```bash
git checkout -b feature/your-feature-name
```

2. **Make your changes** following our coding standards and practices.

3. **Commit your changes** using conventional commit messages:
```bash
git commit -m "type: description"
```

Common types include:
- `feat`: New features
- `fix`: Bug fixes
- `docs`: Documentation changes
- `style`: Code style updates (formatting, missing semi-colons, etc)
- `refactor`: Code changes that neither fix bugs nor add features
- `perf`: Performance improvements
- `test`: Adding or modifying tests
- `chore`: Maintenance tasks

4. **Push your changes**:
```bash
git push origin feature/your-feature-name
```

5. **Submit a Pull Request** to the main repository.

## Pull Request Guidelines

When submitting a pull request:
- Provide a clear description of the changes
- Include the purpose of your changes and any relevant issue numbers
- Ensure all tests pass
- Update documentation if necessary
- Include screenshots for UI changes

## Code Standards

- Follow the existing code style and formatting
- Write clear, descriptive variable and function names
- Include comments for complex logic
- Write tests for new functionality
- Keep commits focused and atomic

## Development Setup

> ⚠️ WARNING: The following monolithic architecture is yet to be implemented and it will be done gradually as stated in [#22](https://github.com/StrapexLabs/strapex/issues/22), for now please refer to the current project structure as is shown in the repository and ignore this section.

Our project uses Turborepo with pnpm workspaces. The repository is structured as follows:

```
apps/
├── www/ # Landing page
├── dashboard/ # Payment gateway interface
└── api/ # Backend services

packages/
├── sdk/ # TypeScript SDK
├── contracts/ # Cairo contracts
└── indexer/ # Blockchain data indexer
```

## Questions and Support

If you have questions or need help:
- Open an issue for feature requests or bug reports
- Join our Telegram community [https://t.me/strapexlabs]
- Check our documentation [Documentation](README)

## Security

For security concerns, please contact any of the project maintainers via their GitHub profiles instead of opening an issue.

## License

By contributing to Strapex, you agree that your contributions will be licensed under our project [license](LICENSE).

## Contributors
<a href="https://github.com/StrapexLabs/strapex/graphs/contributors">
<img src="https://contrib.rocks/image?repo=StrapexLabs/strapex" />
</a>
Loading