Welcome to FreshNest! Whether you're reporting a bug, proposing a feature, thinking about getting involved in the project, or submitting a patch, this document is for you. It serves as an entry point for newcomers to the FreshNest community and a guide/reference for contributors.
There are various ways to contribute to the project, and every contribution is valuable. Your involvement, regardless of its size, makes a difference. Here are some ways to contribute:
- Not ready to work on the project yet? Share your suggestions with us!
- Submit your ideas or report issues. We'd love to hear from you.
You don't have to be a developer to help with the project. Consider these options:
- Answer questions with "General help wanted" or "Technical help wanted" labels.
- Improve documentation.
If you want to contribute code, documentation, or design expertise, here's how to get started:
- Read the documentation, especially the framework-specific guides, React:Web, Flutter:Mobile, and Node.js:Backend.
- Submit a Pull Request (PR) to address tasks like fixing typos in code or documentation.
If you're new to contributing code, follow these steps:
- Create an account on GitHub.
- Review community norms.
- Set up your development environment.
- Familiarize yourself with the codebase.
- Check out issues with "good first issue" labels.
- Claim an issue by commenting on it.
- Work on the issue, submit early PRs, and update your progress.
Additionally, here are some resources that might help:
- https://opensource.guide (Read Guide)
- https://youtu.be/apGV9Kg7ics?si=qchaP453IoJpGMP3 (Video tutorial OSS, Git & GitHub)
Currently, leaving a star 🌟 and spreading word is the best way to support us.
Check out our CODE_OF_CONDUCT and help us foster a welcoming environment in our community.