anipub
Version:
A simple Anime Watching Site using Nodejs
91 lines (64 loc) • 2.27 kB
Markdown
# 🤝 Contributing to AniPub
First off, thanks for considering contributing to **AniPub**!
Your code, ideas, and energy are what drive this project forward. Whether you're fixing a typo or building a new feature, you are awesome.
## 🚀 How to Contribute
1. **Fork the repository**
Click the "Fork" button at the top right to create your own copy.
2. **Clone your fork**
```bash
git clone https://github.com/your-username/AniPub.git
cd AniPub
```
3. **Create a new branch**
```bash
git checkout -b my-cool-feature
```
4. **Install dependencies**
```bash
npm install
```
5. **Start the server locally**
```bash
node backend/app.js
# Open http://localhost:3000 to test your changes
```
6. **Make your changes and commit**
```bash
git add .
git commit -m "Describe your changes"
```
7. **Push to your fork**
```bash
git push origin my-cool-feature
```
8. **Create a Pull Request**
Go to your fork on GitHub and click "New Pull Request".
## 📝 What Can You Contribute?
- Bug fixes and troubleshooting 🐞
- New features and enhancements 🚀
- UI/UX improvements 🎨
- Documentation updates 📝
- Code optimization and refactoring ⚡
- Security improvements 🔒
All skill levels are welcome! If you're not sure where to start, check the [issues](https://github.com/AdnanDLuffy/AniPub/issues).
## 🌟 Contribution Guidelines
- Describe your changes clearly in commits and PRs.
- Follow existing code style (EJS, CSS, JS, Node.js/Express).
- If you add a new feature, update the documentation/wiki if needed.
- Be respectful and constructive in all interactions.
- Test your code before submitting a PR.
## 💬 Need Help?
- Open an [issue](https://github.com/AdnanDLuffy/AniPub/issues) for questions and bug reports.
- Suggest ideas or improvements in Discussions (coming soon).
- For security issues, please see [SECURITY.md](./SECURITY.md).
## 💸 Support AniPub
AniPub is powered by open source and community support.
If you’d like to help with hosting and development costs, see donation links on the [main site](https://anipub.onrender.com) or repo.
Thank you for making AniPub better!
Made with ❤️ by the AniPub community.