Skip to content

Enhance: Update documentation #41

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
AdekunleBamz wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Enhance: Update documentation #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b199283
Update README
AdekunleBamz Feb 26, 2026
1ea3246
Add CONTRIBUTING
AdekunleBamz Feb 26, 2026
1bc47b5
Add .gitignore
AdekunleBamz Feb 26, 2026
5a63832
Add LICENSE
AdekunleBamz Feb 26, 2026
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
34 changes: 1 addition & 33 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/
85 changes: 1 addition & 84 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
22 changes: 1 addition & 21 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!