Enhance contributing guidelines and documentation #2223
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enhance Contributing Guidelines and Documentation
Description:
This pull request introduces significant improvements to the contributing guidelines and documentation of the geemap project. The key enhancements include:
Improved Contributing Guide:
Developed a comprehensive contributing guide to assist new contributors in understanding the contribution process.
Outlined clear steps for setting up the development environment, including detailed instructions for forking the repository, cloning it locally, and creating a new branch.
Provided guidelines on coding standards, testing procedures, and the process for submitting pull requests.
Enhanced README.md:
Updated the README.md file to include an overview of the repository's purpose and structure.
Added sections on how to contribute, community guidelines, and a detailed table of contents for easy navigation.
Included links to the contributing guide and other relevant resources to facilitate new contributors.
Standardized Templates:
Introduced standardized templates for issues and pull requests to ensure consistent and clear communication.
These templates guide contributors in providing necessary information, making it easier for maintainers to review and merge contributions.
Additional Resources:
Created a directory for supplementary documentation and resources, including setup instructions, coding guidelines, and processes for issue tracking and pull requests.
Added examples demonstrating best practices and common pitfalls to help contributors adhere to project standards.
These enhancements aim to streamline the contribution process, making it more accessible and efficient for both new and existing contributors.
Related Issue: This pull request addresses the need to improve the contributing guide and establish rules for merging pull requests, as discussed in Issue #1492.
Checklist:
I have followed the project's coding standards.
I have written tests for new features or bug fixes.
I have updated the documentation as necessary.
I have reviewed my changes and made sure they are clear and concise.
Additional Notes: Please review the changes and provide feedback. I am open to suggestions and willing to make further improvements as needed.
I am using Windows 11 64 bite Operating System