Skip to content

CONTRIBUTING.MD

Latest commit

 

History

History
84 lines (59 loc) · 2.39 KB

CONTRIBUTING.MD

File metadata and controls

84 lines (59 loc) · 2.39 KB

🤝 Contributing to ByteChain Academy

We welcome and appreciate contributions from the community! Here’s how to get involved:

📦 How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone your forked repo: 
    git clone https://github.com/your-username/ByteChain-Academy.git
  3. Create a new branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes and commit using clear messages.
  5. Push to your branch and open a Pull Request to the main branch.

⚠️ Avoid Generic Comments

Comments such as:

  • 🚫 "Can I help with this?"
  • 🚫 "I’d love to contribute!"
  • 🚫 "Check out my profile!"
  • 🚫 "Can I work on this?"

...will not be considered.

Instead, please provide:

  • A brief introduction about yourself
  • A concise plan (3–6 lines max) outlining how you’ll solve the issue
  • Your estimated completion time (ETA)

📢 Join the Community

All contributors must join our official Telegram group to stay in sync: 👉 https://t.me/ByteChainAcademy

🧪 Code of Conduct

Please review our Code of Conduct to help us create a welcoming environment for everyone.

🔧 Development Standards

  • Follow our coding standards (ESLint + Prettier configured).
  • Follow the project structure and naming conventions.
  • Include meaningful commit messages: 
    feat: Add quiz timer component
fix: Resolve routing bug on lesson pages
docs: Update README with new instructions

🧵 Branch Naming Convention

Type Prefix Example
Feature feature/ feature/add-profile-tab
Bugfix fix/ fix/login-validation
Docs docs/ docs/update-contributing

✅ Opening Issues

  • Check if the issue already exists.
  • Use a clear title and description.
  • Add relevant labels if possible (bug, feature, enhancement).

🧪 Testing Guidelines

  • Run all tests before submitting a PR: 
    npm run test
  • Add new tests if introducing new functionality.

🛡️ Security

If you discover a security vulnerability, please do not open an issue. Instead, email us directly at contact@nexacore.org.

Thank you for helping make ByteChain Academy better! 🙌