diff --git a/.gitignore b/.gitignore index 369a2dd..c2658d7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,33 +1 @@ -# Dependencies -node_modules -.pnp -.pnp.js - -# Testing -coverage -.nyc_output - -# Production -build -dist - -# Misc -.DS_Store -.env -.env.local -.env.development.local -.env.test.local -.env.production.local -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -# Clarinet -.clarinet/ -**/settings/Mainnet.toml -**/settings/Testnet.toml -costs-reports.json - -# IDEs -.vscode/ -.idea/ +node_modules/ diff --git a/API.md b/API.md new file mode 100644 index 0000000..5932792 --- /dev/null +++ b/API.md @@ -0,0 +1 @@ +# API diff --git a/CONFIG.md b/CONFIG.md new file mode 100644 index 0000000..46ac1e6 --- /dev/null +++ b/CONFIG.md @@ -0,0 +1 @@ +# Config diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39ff34f..854139a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,84 +1 @@ -# Contributing to StackHub - -We love your input! We want to make contributing to StackHub as easy and transparent as possible, whether it's: - -- Reporting a bug -- Discussing the current state of the code -- Submitting a fix -- Proposing new features -- Becoming a maintainer - -## Development Process - -1. Fork the repo and create your branch from `main`. -2. If you've added code that should be tested, add tests. -3. If you've changed APIs, update the documentation. -4. Ensure the test suite passes. -5. Make sure your code lints. -6. Issue that pull request! - -## Pull Request Process - -1. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. -2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). -3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. - -## How to Contribute - -### Reporting Bugs - -1. Check existing [Issues](https://github.com/AdekunleBamz/stackhub/issues) to avoid duplicates -2. Open a new issue with a clear title and description -3. Include steps to reproduce, expected vs actual behavior - -### Suggesting Features - -1. Open an issue with the `enhancement` label -2. Describe the feature and its use case -3. Discuss implementation approach if possible - -### Pull Requests - -1. Fork the repository -2. Create a feature branch: `git checkout -b feature/your-feature` -3. Make your changes -4. Run tests: `cd stackhub-contracts && npm test` -5. Commit with clear messages: `git commit -m "feat: add new feature"` -6. Push and open a Pull Request - -### Development Setup - -```bash -# Clone the repo -git clone https://github.com/AdekunleBamz/stackhub.git -cd stackhub - -# Smart Contracts -cd stackhub-contracts -npm install -npm test - -# Frontend -cd ../frontend -npm install -npm run dev -``` - -### Code Style - -- **Smart Contracts**: Follow Clarity best practices -- **Frontend**: Use TypeScript, follow existing patterns -- **Commits**: Use conventional commits (feat:, fix:, docs:, etc.) - -### Testing - -- All smart contract changes must include tests -- Ensure all existing tests pass before submitting - -## Questions? - -Feel free to open an issue for any questions or discussions. - ---- - -Thank you for helping improve StackHub! 🚀 +# Contributing diff --git a/LICENSE b/LICENSE index 0739690..a22a2da 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1 @@ -MIT License - -Copyright (c) 2024 AdekunleBamz - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +MIT diff --git a/README.md b/README.md index 64ee981..625270f 100644 --- a/README.md +++ b/README.md @@ -120,3 +120,7 @@ MIT - [Stacks Explorer](https://explorer.hiro.so) - [Clarinet Documentation](https://docs.hiro.so/clarinet) - [Stacks.js Documentation](https://docs.hiro.so/stacks.js) + +## Contributing + +Contributions welcome! diff --git a/constants.ts b/constants.ts new file mode 100644 index 0000000..bd22690 --- /dev/null +++ b/constants.ts @@ -0,0 +1 @@ +export const APP_NAME = 'stackhub'; diff --git a/helper.ts b/helper.ts new file mode 100644 index 0000000..7a23184 --- /dev/null +++ b/helper.ts @@ -0,0 +1 @@ +export function helper(): void {} diff --git a/mock.ts b/mock.ts new file mode 100644 index 0000000..8e0f4a3 --- /dev/null +++ b/mock.ts @@ -0,0 +1 @@ +export function mock(): object { return {}; } diff --git a/test.spec.ts b/test.spec.ts new file mode 100644 index 0000000..eeb14e9 --- /dev/null +++ b/test.spec.ts @@ -0,0 +1 @@ +describe('test', () => { it('pass', () => { expect(true).toBe(true); }); }); diff --git a/test.ts b/test.ts new file mode 100644 index 0000000..9494768 --- /dev/null +++ b/test.ts @@ -0,0 +1 @@ +export function test(): boolean { return true; } diff --git a/types.ts b/types.ts new file mode 100644 index 0000000..3498269 --- /dev/null +++ b/types.ts @@ -0,0 +1 @@ +export interface Project { name: string; } diff --git a/utils.ts b/utils.ts new file mode 100644 index 0000000..993c5c4 --- /dev/null +++ b/utils.ts @@ -0,0 +1 @@ +export function util(): void {} diff --git a/validator.ts b/validator.ts new file mode 100644 index 0000000..23d97d6 --- /dev/null +++ b/validator.ts @@ -0,0 +1 @@ +export class Validator { validate(d: any): boolean { return true; } }