PecanProject / pecan

The Predictive Ecosystem Analyzer (PEcAn) is an integrated ecological bioinformatics toolbox.
www.pecanproject.org
Other
199 stars 231 forks source link

Fix Typo Errors and Errors in Markdown documentations #3246

Closed Sweetdevil144 closed 6 months ago

Sweetdevil144 commented 6 months ago

Improved the quality of CONTRIBUTING.md and other markdown files:

Description

It does not actually fix #3245 because I do not have access to modified links, but I surely can change them if provided with the links.

Motivation and Context

Fixes markdown linting issues in CONTRIBUTING.md

3245

Review Time Estimate

Types of changes

Checklist:

allgandalf commented 6 months ago

Thanks for the PR @Sweetdevil144 ,if you're interested in contributing to the documentation further then maybe you can explore the issue : #2576 , we would appreciate your help :)

Sweetdevil144 commented 6 months ago

@RohanSasne Sure !! I'll look more into it and create a PR for the same !! Meanwhile, I'll continue to make more documentation changes to this and notify you when I'm done with the same.

Sweetdevil144 commented 6 months ago

Ready to be merged @RohanSasne I've made all possible documentation improvements. Just one question are documentations like NEWS.md and CHANGELOG.md auto generated? If yes, then we would need changes in configuration of auto generation file to remove some basic errors.

mdietze commented 6 months ago

NEWS and CHANGELOG are not autogenerated. It's always good to note changes in the latter as part of a PR