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

Improve Grammar, Nomenclature, and Link Updates in the InnerSource Patterns book #719

Open
agostontorok opened this issue Oct 2, 2024 · 3 comments
Labels
hacktoberfest Started for hacktoberfest 2022, continued in 2024

Comments

@agostontorok
Copy link

Issue Description:

We are seeking contributors to help enhance the readability and accuracy of chapters of the InnerSource Patterns Book. This effort is part of Hacktoberfest, an initiative to encourage participation in open source projects. Beginners are especially welcome! This task involves checking for grammar and typographical errors, ensuring the consistency of terminology used throughout one (!) chapter, and verifying that all hyperlinks are functional and up-to-date.

Goals:

  • Grammar and Typo Checks: Review the chapter for any grammatical errors and typos. This includes but is not limited to punctuation, capitalization, verb tense, and sentence structure.
  • Consistency of Nomenclature: Ensure that all terminology and jargon are used consistently throughout the chapter. For example, if "InnerSource" is capitalized in one section, it should be capitalized throughout.
  • Update Not Working Links: Check all hyperlinks within the chapter to ensure they are not broken. Replace any outdated or non-working links with the correct URLs.

Instructions for Contributors:

  • Fork the Repository: Start by forking the repository to your GitHub account.
  • Clone the Repository: Clone the forked repository to your local machine.
  • Make Your Changes: As you read through the chapter of your choice, make edits to correct grammar, ensure terminology consistency, and update broken links.
  • Commit Changes: Commit your changes with a clear commit message, e.g., "Fix typos in Chapter 5", "Standardize terminology in Chapter 5", or "Update broken links in Chapter 5".
  • Push Changes: Push your changes to your forked repository on GitHub.
  • Create a Pull Request: Submit a pull request from your fork to the original ISC book repository. Make sure to describe what changes you've made and why.
  • Wait for Review: Your pull request will be reviewed by maintainers, who may suggest further modifications or merge your changes.

Helpful Resources:

GitHub Forking and Cloning Guide
Markdown Syntax Guide
Understanding Pull Requests

Getting Help:

If you need help with this task, please feel free to reach out on our community Discord channel or comment directly on this issue. We're happy to assist newcomers!

Note:

This task is beginner-friendly and a great way to learn about contributing to open-source projects, particularly in the realm of technical writing and documentation. We appreciate your contributions to making ISC resources more accessible and accurate!

@agostontorok agostontorok added the 1-initial Donuts, Early pattern ideas, ... (Please see our contribution handbook for details) label Oct 2, 2024
Copy link

welcome bot commented Oct 2, 2024

Welcome Banner
🎉 Welcome to The InnerSource Commons community, and in particular to our patterns! 🎉 We're really excited to have your input into the project! 💖

If you haven't done so already, please check out our Contributing Guidelines. If you need to connect more synchronously with members of The InnerSource Commons community, come chat with us in our Slack workspace.

@spier spier changed the title Improve Grammar, Nomenclature, and Link Updates in the Inner Source Patterns book Improve Grammar, Nomenclature, and Link Updates in the InnerSource Patterns book Oct 2, 2024
@spier spier added hacktoberfest Started for hacktoberfest 2022, continued in 2024 and removed 1-initial Donuts, Early pattern ideas, ... (Please see our contribution handbook for details) labels Oct 2, 2024
@dhirajs16
Copy link

Hey @spier, is the grammatical error issue in Chapter 5 still valid? If so, assign me the issue so I can resolve it.

@spier
Copy link
Member

spier commented Oct 4, 2024

Hey @spier, is the grammatical error issue in Chapter 5 still valid? If so, assign me the issue so I can resolve it.

Come again @dhirajs16? Which chapter 5 are you referring to? Can you share a link to what you mean, so that there are no misunderstandings?

@spier spier pinned this issue Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest Started for hacktoberfest 2022, continued in 2024
Projects
None yet
Development

No branches or pull requests

3 participants