Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Local Development Environment documentation. #684

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

ultralegendary
Copy link

Description

Hi,
I have resturctured the Local Development Environment document to have clear instructions. We can consider this is not final draft as the description of the #677 says there are some vital information that needs to be added. I am expecting a review and suggestion list on what needs to be added apart from the existing content here.

I have hosted this documentation here for testing and showing the changes: https://dhivaversion-nearbeach.readthedocs.io/en/latest/002-local-development-environment-setup/index.html

Here are the list of changes made at a high level:

  • Pushed the below text box to the end and merged with "Start contributing section"
image
  • Removed Django reference from docs as these dependencies are already present in the requirements.txt and automatically gets installed. Please let me know if this should be added back
image
  • Removed the below warnings and as these are covered in prerequsities
image
  • Added a short description
  • Added prerequities section
  • Modified setting up the project section
  • Added whats next section.

Added Dependency :

Added extension: sphinx.ext.intersphinx in /docs/conf.py file

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Database change that requires a migration
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Local manual testing via "./manage runserver"
  • Local Python Unit Testing via "./manage test"
  • Local Cypress E2E Testing
  • Tested on virtual box
  • Tested on server

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link

deepsource-io bot commented Oct 5, 2024

Here's the code health analysis summary for commits 6ba494c..a2cdd37. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource JavaScript LogoJavaScript✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link
Collaborator

@robotichead robotichead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much :D

@robotichead robotichead merged commit 364a49c into nearbeach:main Oct 7, 2024
2 checks passed
@ultralegendary
Copy link
Author

hey @robotichead, Can you had hacktoberfest-accepted label to this pr

@robotichead
Copy link
Collaborator

Sorry. Just done :D

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.

2 participants