Contributing

PicPeak is open source under the MIT license. Contributions are welcome --- whether fixing bugs, adding features, or improving documentation.

Ways to contribute

• Report bugs --- open a GitHub issue  with steps to reproduce, expected behavior, and your environment details.
• Suggest features --- describe the enhancement and why it would be useful.
• Submit pull requests --- fork the repo, create a branch from main, and submit a PR.
• Improve documentation --- fix typos, add examples, or clarify existing docs.

First contribution

Look for issues labeled:

• good first issue  --- small, well-scoped changes.
• help wanted  --- issues that need community help.

Pull request process

1. Fork the repo and create your branch from main.
2. Install dependencies: cd backend && npm install && cd ../frontend && npm install.
3. Make your changes. Follow the existing code style.
4. Ensure tests pass: npm test in both backend/ and frontend/.
5. Ensure linting passes: npm run lint in both directories.
6. Write tests for new code.
7. Update documentation if needed.
8. Submit the pull request.

Code style

• ES6+ features, async/await over raw promises.
• Functional React components with hooks.
• TypeScript in the frontend.
• JSDoc comments for functions.
• Follow ESLint rules configured in the project.

Commit messages

• Present tense, imperative mood (“Add feature”, not “Added feature”).
• First line under 72 characters.
• Reference issues and PRs after the first line.

Contact

• GitHub Issues  for bugs and features.
• GitHub Discussions  for questions.