Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contributing to UN SDG Advocate

Thanks for your interest in contributing to this project.

## How to Contribute

1. Fork the repository and clone your fork locally.
2. Create a new branch for your work.
3. Make your changes in a focused, well-scoped commit.
4. Run the project locally and verify your changes.
5. Open a pull request against the main branch.

## Local Setup

This project has a Python backend and a Next.js frontend.

Backend:

```bash
cd backend
python3 -m venv myvenv
source ./myvenv/bin/activate
pip install -r requirements.txt
python3 app.py
```

Frontend:

```bash
cd frontend
npm install
npm run dev
```

## Contribution Guidelines

- Keep changes small and easy to review.
- Follow the existing code style and project structure.
- Include tests or validation steps when they apply to your change.
- Update documentation when your change affects usage or setup.
- Avoid unrelated refactors in the same pull request.

## Pull Request Checklist

- The branch is up to date with the latest main branch.
- The code builds and runs correctly.
- Any new behavior is described clearly in the pull request.
- Screenshots or logs are included when they help explain the change.

## Reporting Issues

If you find a bug or want to request a feature, open an issue with:

- A clear title
- Steps to reproduce
- Expected and actual behavior
- Relevant logs, screenshots, or links
- Create an issue beforehand and discuss with maintainers
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,7 @@ Analyzes a GitHub repository and its description for SDG alignment using Aurora

## Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request
If you are interested in contributing to this project, please read the [Contributing.md](Contributing.md) file.

## License

Expand Down