Skip to content

CONTRBUTING.md

Latest commit

 

History

History
152 lines (100 loc) · 3.52 KB

CONTRBUTING.md

File metadata and controls

152 lines (100 loc) · 3.52 KB
Raw

Contributing to NoteNest

Thank you for your interest in contributing to NoteNest 🎉
NoteNest is part of Open Source Quest (OSQ) and follows professional, industry-aligned open-source contribution practices.

Please read this document carefully before starting your contribution.

📜 Code of Conduct

By participating in this repository, you agree to abide by our Code of Conduct.

We are committed to maintaining a respectful, inclusive, and welcoming environment for everyone.

🧩 Ways to Contribute

You can contribute in multiple areas:

  • Frontend development (Next.js, UI/UX, etc)
  • Backend development (REST, GraphQL APIs, etc)
  • Documentation and technical writing
  • Testing and quality assurance
  • Accessibility improvements
  • Performance and optimization work

Issues are labeled by:

  • Skill area: frontend, backend, documentation, ui/ux, testing
  • Difficulty: good first issue, easy, medium, hard

🚀 Contribution Workflow

1️⃣ Choose or Create an Issue

  • Check existing issues before starting work
  • If proposing a new change, create an issue using the correct template
  • Do not start work without an approved issue

2️⃣ Get Assigned

  • Comment on the issue you want to work on
  • Wait for a maintainer or mentor to assign it to you
  • Only one active issue per contributor is allowed at a time

3️⃣ Fork & Create a Branch

Fork the repository and create a new branch from main:

4️⃣ Make Your Changes

  • Keep changes focused on the assigned issue
  • Follow the existing project structure and coding style
  • Write clear, readable, and maintainable code
  • Update or add documentation where applicable

5️⃣ Commit Message Guidelines

Use clear and meaningful commit messages:

6️⃣ Open a Pull Request (PR)

When ready:

  • Push your branch to your fork
  • Open a Pull Request to the main branch
  • Fill in the Pull Request template completely

Your PR must include:

  • A link to the related issue
  • A clear explanation of the changes
  • Screenshots or recordings for UI changes
  • Documentation updates if relevant

🔍 Review Process

  • Maintainers and mentors will review your PR
  • Feedback may be requested — this is part of the learning process
  • Please respond to review comments politely and promptly
  • Approved PRs will be merged by a maintainer

🔒 Branch Protection Rules

  • The main branch is protected
  • ❌ No direct commits to main
  • ✅ All changes must go through Pull Requests
  • PR approval is required before merging

🧪 Testing & Quality Standards

Before submitting a PR:

  • Test your changes locally
  • Ensure builds and tests pass
  • Avoid breaking existing functionality
  • Follow basic security and performance best practices

📚 Documentation Contributions

Documentation is highly valued.

You can contribute by:

  • Improving setup or installation guides
  • Writing API documentation
  • Adding architecture explanations
  • Fixing typos or unclear sections

Documentation-only pull requests are welcome.

🆘 Need Help?

If you are unsure about anything:

  • Ask questions in the issue discussion
  • Reach out to mentors or maintainers
  • Contact the OSQ team at:

osq@r3actr.work

We encourage asking questions early.

🏁 Final Notes

  • Quality and clarity matter more than quantity
  • Follow mentor guidance and project rules
  • Be respectful and collaborative — open source is a team effort

Happy contributing 🚀
— NoteNest Maintainers