Skip to content

Commit

Permalink
Minor copy tweaks
Browse files Browse the repository at this point in the history
Just reading through pages and tweaking things. Definitely lots to change overall.
  • Loading branch information
GBKS committed Aug 2, 2024
1 parent 1762bb1 commit 8422e1a
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 28 deletions.
16 changes: 8 additions & 8 deletions content/0-curriculum-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ images:

# Introduction

Welcome to our comprehensive curriculum on contributing to open source projects as a designer! This course is designed to equip you with the knowledge, skills, and confidence to make meaningful contributions to the world of open source software.
Welcome to [our](/13-about) comprehensive guide on contributing to open source projects as a designer! This site is designed to equip you with the knowledge, skills, and confidence to make meaningful contributions to the world of open source software.

## What's Included

This curriculum consists of 12 chapters, each focusing on a crucial aspect of open source design:
This guide consists of 12 chapters, each focusing on a crucial aspect of open source design:

1. [Introduction to Open Source](/1-open-source)
2. [Understanding the Designer's Role](/2-the-designers-role)
Expand All @@ -46,9 +46,9 @@ This curriculum consists of 12 chapters, each focusing on a crucial aspect of op

Each chapter includes detailed explanations, practical tips, and real-world examples to help you understand and apply the concepts.

## Benefits of This Curriculum
## Benefits of This Guide

By completing this course, you'll gain:
By completing all chapters, you'll gain:

1. Practical skills for contributing to open source projects
2. Understanding of open source culture and workflows
Expand All @@ -58,9 +58,9 @@ By completing this course, you'll gain:
6. A significant portfolio piece from your final project
7. The ability to make a real impact on software used by people worldwide

Whether you're a student, a professional designer looking to expand your skills, or simply interested in giving back to the open source community, this curriculum will provide valuable knowledge and experience.
Whether you're a student, a professional designer looking to expand your skills, or simply interested in giving back to the open source community, this guide will provide valuable knowledge and experience.

## How to Use This Curriculum
## How to Use This Guide

Here are some tips to get the most out of this course:

Expand All @@ -76,7 +76,7 @@ Here are some tips to get the most out of this course:

6. Final Project: The final chapter guides you through a substantial project. This is your chance to apply everything you've learned, so give it your best effort!

7. Continuous Learning: Open source is always evolving. Use this curriculum as a foundation, but keep learning and staying updated on new trends and practices.
7. Continuous Learning: Open source is always evolving. Use this guide as a foundation, but keep learning and staying updated on new trends and practices.

## Getting Started

Expand All @@ -86,7 +86,7 @@ Ready to begin your journey into open source design? Here's how to get started:
2. Set aside regular time for studying and practicing.
3. Prepare your design tools – both digital and traditional.
4. Join online communities related to open source design.
5. Start with Chapter 1 and work your way through the curriculum.
5. Start with [Chapter 1](/1-open-source) and work your way through the guide.

Remember, the open source community values initiative and enthusiasm. Don't be afraid to jump in and start contributing, even as you're learning. Your fresh perspective as a newcomer can be incredibly valuable to projects.

Expand Down
10 changes: 5 additions & 5 deletions content/1-open-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ images:

## What is Open Source?

Open source is a fascinating concept that has revolutionized the way software is developed and distributed. At its core, open source refers to software whose source code – the underlying instructions that make the program work – is freely available for anyone to view, modify, and distribute. This approach stands in stark contrast to proprietary or "closed source" software, where the source code is kept secret and tightly controlled by its owners.
[Open source](https://en.wikipedia.org/wiki/Open_source) is a fascinating concept that has revolutionized the way software is developed and distributed. At its core, open source refers to software whose source code – the underlying instructions that make the program work – is freely available for anyone to view, modify, and distribute. This approach stands in stark contrast to proprietary or "closed source" software, where the source code is kept secret and tightly controlled by its owners.

But open source is more than just visible code. It's a philosophy that extends far beyond the realm of software development. The open source movement embodies principles of collaboration, transparency, and community-driven innovation. It's about fostering a culture where knowledge is shared freely and improvements are made collectively.

Imagine a world where the blueprint for every piece of technology is available for all to see and improve upon. That's the essence of open source. It's like a global potluck dinner where everyone brings a dish to share, and together, we create a feast that's far more diverse and delicious than any one person could have made alone.

## Key Principles of Open Source
## Key Principles

The open source philosophy is built on several fundamental principles that guide how these projects operate and grow.

Expand All @@ -57,7 +57,7 @@ In the open source world, contributions are typically judged on their merit, not

Perhaps one of the most powerful aspects of open source is the strong sense of community that often develops around these projects. Contributors from around the world come together, united by a shared goal of improving the software they're working on.

## Benefits of Contributing to Open Source Projects
## Benefits of Contributing

For designers, dipping your toes into the open source world can be an incredibly rewarding experience. It's not just about giving back to the community – although that's certainly a big part of it. Contributing to open source projects can significantly boost your career and personal growth in numerous ways.

Expand All @@ -81,13 +81,13 @@ For those who make significant contributions, open source can be a path to recog

Lastly, many people find great personal satisfaction in contributing to open source projects. There's something special about knowing that your work is benefiting the wider community, often in ways you might never have imagined.

## Common Misconceptions about Open Source
## Common Misconceptions

Despite its growing popularity, there are still some common misconceptions about open source that are worth addressing.

### Only for developers

One prevalent myth is that open source is only for programmers. While it's true that coding plays a significant role in many open source projects, there's a growing need for a variety of skills. Designers, writers, testers, and many other non-coding roles are crucial to the success of open source projects. In fact, good design is becoming increasingly recognized as a key factor in the adoption and usability of open source software.
One prevalent myth is that open source is only for programmers. While it's true that coding plays a significant role in many open source projects, there's a growing need for a variety of skills. Designers, writers, testers, and many other non-coding roles are crucial to the success of open source projects. In fact, good design is becoming increasingly recognized as a key factor in the adoption and usability of open source software. Read more about this in [chapter 2](/2-the-designers-role).

### It's always free

Expand Down
31 changes: 18 additions & 13 deletions content/3-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ images:

## Finding the Right Project

Embarking on your open source design journey begins with finding the right project. Start by taking a moment to reflect on your skills and interests. What are you best at? Perhaps you excel at UI design, or maybe UX research is your forte. Consider the types of projects that excite you - are you drawn to web applications, mobile apps, or desktop software?
Embarking on your open source design journey begins with finding the right project. Start by taking a moment to reflect on your skills and interests. What are you best at? Perhaps you excel at UI design, or maybe UX research is your forte. Consider the types of projects that excite you - are you drawn to web applications, mobile apps, or desktop software? Maybe you already use a piece of software that you'd like to help improve.

Once you have a clear idea of what you're looking for, it's time to explore the vast landscape of open source platforms. [GitHub](https://github.com/) is the largest host of open source projects and a great place to start your search. Don't overlook other platforms like [GitLab](https://about.gitlab.com/), which also host many established open source projects.

Expand Down Expand Up @@ -55,7 +55,7 @@ Finally, check if the project has any specific design resources. Some projects h

Before you start contributing, it's crucial to understand the project's contribution guidelines. These guidelines ensure that your contributions align with the project's goals and standards.

Begin by thoroughly *reading the project's documentation**. This will help you understand the project's vision, goals, and any existing design principles. This knowledge will inform your design decisions and help you create contributions that truly benefit the project.
Begin by thoroughly **reading the project's documentation**. This will help you understand the project's vision, goals, and any existing design principles. This knowledge will inform your design decisions and help you create contributions that truly benefit the project.

When you're just starting out, it's often best to **begin with small contributions**. Look for issues tagged as "good first issue" or "beginner-friendly". These are typically smaller tasks that are well-suited for newcomers. You might start by improving documentation, creating small UI elements, or even just participating in discussions.

Expand All @@ -69,45 +69,50 @@ Make sure you **understand the process** for submitting your work. Many projects

Contributing to open source projects often requires specific tools and accounts. Let's go through the essentials you'll need to set up.

Version control is a fundamental part of open source development. Git is the most commonly used version control system, so you'll want to install it on your local machine. Take some time to learn the basics of Git if you're not already familiar with it.
### Version control
Version control is a fundamental part of open source development. Git is the most commonly used system, so you'll want to install it on your local machine. Take some time to learn the basics of Git if you're not already familiar with it.

### Project hosting
You'll also need to create accounts on the platforms where the projects you're interested in are hosted. This often means setting up a GitHub account, but you might also need accounts on GitLab or other platforms depending on the projects you choose.

### Design tools
As a designer, you'll need appropriate [design tools](/6-design-tools/). While many designers are accustomed to proprietary software, consider exploring open source alternatives like GIMP for image editing, Inkscape for vector graphics, or Krita for digital painting. These tools align well with the open source philosophy and ensure your design files are accessible to the wider community.

Make sure your tools can export to the formats specified by the project. SVG is often preferred for vector graphics in open source projects due to its scalability and ease of modification.

### Communication
Set up accounts for any project-specific communication tools. This might include Slack, Discord, or forum accounts depending on what the project uses.

### Local development
Some projects may require you to run the software locally to fully understand and test your design contributions. In these cases, you'll need to set up a development environment on your machine. Follow the project-specific setup instructions carefully, and don't hesitate to ask for help if you run into difficulties.

## Making Your First Contribution

Now that you're set up and familiar with the project, it's time to make your first contribution. This can feel intimidating, but remember, every expert was once a beginner.

Start by choosing an issue to work on. Select a task that matches your skills and the project's needs. If you're unsure, it's perfectly okay to ask for guidance from the community.
Start by choosing an issue to work on. **Select a task** that matches your skills and the project's needs. If you're unsure, it's perfectly okay to ask for guidance from the community.

Once you've chosen an issue, it's good practice to comment on it, letting others know you're working on it. This prevents duplicate work and opens the door for others to offer help or suggestions.
Once you've chosen an issue, it's good practice to **comment on it**, letting others know you're working on it. This prevents duplicate work and opens the door for others to offer help or suggestions.

Now comes the exciting part - doing the work! Create your design, keeping in mind the project's guidelines and any feedback you've received. As you work, document your process and the reasoning behind your decisions. This documentation will be valuable when you submit your contribution.
Now comes the exciting part - doing the work! **Create your design**, keeping in mind the project's guidelines and any feedback you've received. As you work, document your process and the reasoning behind your decisions. This documentation will be valuable when you submit your contribution.

When you're ready to submit your work, follow the project's submission process. This is often done through a pull request if the project is hosted on GitHub. Include a clear description of your work, explaining what you've done and why. If your contribution addresses a specific issue, make sure to reference it.
When you're ready to **submit your work**, follow the project's submission process. This is often done through a pull request if the project is hosted on GitHub. Include a clear description of your work, explaining what you've done and why. If your contribution addresses a specific issue, make sure to reference it.

After submitting, be prepared to receive feedback. Respond to comments promptly and be open to making changes. Remember, feedback is not criticism of you personally, but a normal part of the collaborative open source process.
After submitting, **be prepared to receive feedback**. Respond to comments promptly and be open to making changes. Remember, feedback is not criticism of you personally, but a normal part of the collaborative open source process.

## Best Practices for New Contributors

As you begin your open source journey, keep these best practices in mind:

Be patient. Open source communities often move at their own pace, which can be slower than you might expect. Don't get discouraged if you don't receive immediate responses.
**Be patient**. Open source communities often move at their own pace, which can be slower than you might expect. Don't get discouraged if you don't receive immediate responses.

Maintain a positive attitude, even if your work isn't accepted immediately. Every interaction is a learning opportunity.
**Maintain a positive attitude**, even if your work isn't accepted immediately. Every interaction is a learning opportunity.

Embrace the learning process. Each project you contribute to is a chance to expand your skills and knowledge.
**Embrace the learning process**. Each project you contribute to is a chance to expand your skills and knowledge.

Consistency is key. Regular, small contributions can have a big impact over time and help you build a strong reputation within the community.
**Consistency is key**. Regular, small contributions can have a big impact over time and help you build a strong reputation within the community.

Always respect the community. Follow the project's code of conduct and communication norms. Remember, you're joining an existing community with its own culture.
Always **respect the community**. Follow the project's code of conduct and communication norms. Remember, you're joining an existing community with its own culture.

## Conclusion

Expand Down
6 changes: 4 additions & 2 deletions content/6-design-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,15 @@ When creating a design system for your open source project, consider using tools

## Accessibility Tools

Ensuring accessibility is a crucial aspect of open source design, as these projects often aim to be usable by as wide an audience as possible. Several open source tools can help you evaluate and improve the accessibility of your designs:
Ensuring [accessibility](/8-improving-ux#designing-for-accessibility) is a crucial aspect of open source design, as these projects often aim to be usable by as wide an audience as possible. Several open source tools can help you evaluate and improve the accessibility of your designs:

1. [WAVE](https://wave.webaim.org/): A web accessibility evaluation tool that provides visual feedback about the accessibility of your web content.
2. [Contrast Checker](https://webaim.org/resources/contrastchecker/): A simple tool to check the contrast ratio of your color choices to ensure readability.
3. [Axe](https://www.deque.com/axe/): An accessibility testing engine that can be integrated into automated workflows.

Remember that while these tools are helpful, they should complement, not replace, manual testing and feedback from users with disabilities.
Additionally, it's important to familiarize yourself with and regularly use the built-in accessibility features provided by major operating systems (Windows, macOS, iOS, Android). These include screen readers, magnifiers, and other assistive technologies. By using these tools during your design process, you can better understand how users with different abilities will interact with your software.

Remember that while these tools are helpful, they should complement, not replace, manual testing and feedback from users with disabilities. Regular testing throughout the design and development process is crucial to ensure consistent accessibility.

## Version Control for Designers

Expand Down

0 comments on commit 8422e1a

Please sign in to comment.