search

PalisadoesFoundation / talawa-admin

Admin portal for the Talawa Mobile App. Click on the link below to see our documentation
https://docs.talawa.io/
GNU General Public License v3.0
146 stars 602 forks source link

Minor Typos and Formatting Issues #2178

Closed TyagiRajat closed 3 months ago

TyagiRajat commented 3 months ago

There are a few minor typos and formatting issues in the README.md file that need to be addressed:

Typo in the Documentation section:

The word "documenation" is misspelled and should be corrected to "documentation." Inconsistent Capitalization:

The phrase "web based" in the Talawa Components section should be hyphenated to "web-based" for proper grammatical structure. Capitalization inconsistency in the Table of Contents section, where "Talawa Components" is capitalized differently from other headers like "Documentation" and "Videos." Consider updating for consistency. Formatting:

Consider enhancing the clarity and consistency of the text, particularly in the Videos section, to improve readability

github-actions[bot] commented 3 months ago

Congratulations on making your first Issue! :confetti_ball: If you haven't already, check out our Contributing Guidelines and Issue Reporting Guidelines to ensure that you are following our guidelines for contributing and making issues.

palisadoes commented 3 months ago

We are now focusing on three types of issues as priority areas:

  1. The improvement in the reliability of our code base. There are many issues created to test existing code. It is a good place to start if you want to understand the operation of various apps. When you submit PRs, we automatically check to see whether the code you submitted has been covered by testing and that each file meets the minimum standard level of the repository as a whole. You won’t be able to avoid understanding testing regimes to contribute to Talawa.
  2. The fixing of bugs and features that seriously hamper the user from using the application. The apps have various shortcomings. The most obvious ones are where the apps do not work as expected. For example buttons that don’t work, errors or messages that are not displayed to make the user understand what to do and many more. Think of any difficulty you have had in getting things working, there could be a bug there waiting for you.
  3. Coding of screens for issues created by our Contributor team based on our soon to be updated design guide. This may include updates to existing screens.
  4. The creation of additional or updated documentation that helps with improving both the experience of the end user and the various GitHub contributors who support the development of our software. This would include user guides.

We will only be accepting feature issues for deficiencies that are obviously lacking in the apps. These are things that make it very difficult to operate the apps. Even so, the PRs will still require you to understand testing as stated before.

Cosmetic changes that require only a few lines of code, or relate to screen sizes unlikely to be used are not acceptable under this policy.

Closing