Skip to content

Conversation

akwasigroch
Copy link
Collaborator

This PR introduces changes from the fix/contributing-guide branch.

📝 Summary

📁 Files Changed ( 2 files)

apps/backend/CONTRIBUTING.md
CONTRIBUTING.md

📋 Commit Details

faa980c - fix link, add more information (Arkadiusz Kwasigroch, 2025-09-05 09:10)
fffddd2 - add the information about specific contributing guides to the main contributing.md (Arkadiusz Kwasigroch, 2025-08-19 16:43)

✅ Checklist

  • Code follows the project's style guidelines
  • Self-review of code has been performed
  • Code is commented, particularly in hard-to-understand areas
  • Corresponding changes to documentation have been made
  • Tests have been added/updated for new functionality
  • All tests pass locally

🧪 Testing

📸 Screenshots (if applicable)

🔗 Related Issues

@akwasigroch akwasigroch self-assigned this Sep 5, 2025
@akwasigroch akwasigroch added this to the Release 5 (ETA 19. Sept) milestone Sep 5, 2025
@akwasigroch akwasigroch linked an issue Sep 5, 2025 that may be closed by this pull request
@EmanueleDeRossi1
Copy link
Collaborator

Thank you for fixing the links and improving the CONTRIBUTING guide :)

There are a couple of things that I think should be removed/improved in the main CONTRIBUTING:

  1. On Development Workflow there is still an old indication to use pre-commit install, even if now we are using uvx pre-commit install
  2. On Development Workflow there is also a duplicate of indication of how to use Makefile
  3. In general, what do you think about integrating the section Coding Standards Linting and Formatting all into Development Workflow?
  4. In Pull-Request Process, there is written to update the CHANGELOG every time we do a PR. We are currently not doing this, maybe we should remove it?
  5. In Pull-Request Process, under Additional Requirements, there is written to follow the conventional commit specification. This is a repetition, since the commit specifications are indicated in the section above. I would generally remove the subsection Additional Requirements completely, since "Include tests..." and "Update documentation..." is also repeated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fixes in the documentation
2 participants