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

Create Contributor Development Guide #138

Open
devondragon opened this issue Jan 21, 2025 · 7 comments
Open

Create Contributor Development Guide #138

devondragon opened this issue Jan 21, 2025 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@devondragon
Copy link
Owner

Develop a comprehensive Developer Contribution Guide for the project. The guide should include:

  • Instructions on setting up a local development environment.
  • Project standards and coding conventions.
  • Steps for submitting contributions, including pull request requirements and best practices.
  • Guidelines for reporting bugs and suggesting features.
  • An overview of the project's workflow and any necessary tools or dependencies.
@devondragon devondragon added the documentation Improvements or additions to documentation label Jan 21, 2025
@Brijeshthummar02
Copy link

@devondragon assign me , i'll do it.

Copy link

Branch issue-138-Create-Contributor-Development-Guide created!

@devondragon
Copy link
Owner Author

@Brijeshthummar02 - Thanks! Most development will require both forking this project, and also the SpringUserFrameworkDemoApp project as well, to test the library and to potentially add any related functionality to the Demo app for reference. So steps like 'gradle publishLocal' from the library project, and then updating the dependency version in the DemoApp's build.gradle to pull from that locally built library, etc... will be needed.

Let me know if you have any questions or run into any issues. I appreciate your help!!

@devondragon devondragon moved this from To do to In progress in SpringUserFramework Jan 22, 2025
@devondragon
Copy link
Owner Author

@Brijeshthummar02 - have you been able to make any headway on this? I realize it might be difficult to figure out in a vacuum so I'm happy to assist or just write it up (like I probably should have earlier). Let me know what you think would work best.

@devondragon
Copy link
Owner Author

I've added a developer guide on the issue-138 branch, but have yet to do a full walk through and testing it for completeness.

@Brijeshthummar02
Copy link

@devondragon it's taking too long, i was in between my university exams so ya, will be going through the complete repo and provide req documentation also if you get the time, do make it I'll finish it.

@devondragon
Copy link
Owner Author

@Brijeshthummar02 - if you have time to test out the DEVELOP.md guide on the issue-138 branch, and provide changes, fixes, feedback, that would be great. I will also do a clean run through myself this week and improve the guide, but I'd love another set of eyes on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In progress
Development

No branches or pull requests

2 participants