Topic 6: Contributing Beyond Code

Friday, May 19, 2023





Topic 6: Contributing Beyond Code

What other forms beyond code can complement your contribution? How can you improve the outreach and accessibility by considering other noncode related contributions?




Although open-source projects are often associated with code-based contributions, potential contributors are not limited to just code contributions (Wang, 2016). After contributing to different open-source projects, I noticed that impactful contributions can be made without necessarily involving coding. Hence, I complied a list of open-source contributions beyond code that may be equally as valuable to an open-source project. 


1.Documentation

The first and most common non-code contribution is documentation. This may include writing tutorial on specific functions or designing a guideline for a feature or "code of conduct" (Pottekkat, 2023). Essentially, the purpose of a documentation contribution is to help anyone who may come across the project (e.g. contributors, users, etc) understand the project, weather its to use or to contribute. 

As discussed in Week 10's lecture on "Documentation", good documentation can go a long way as it will act as the end-users and collaborator's safety net and "key" to all their questions. Especially clear and comprehensive instructions on installing and configuring the open-source project are valuable for both end-users and project collaborators. Such instructions not only guide users in effectively utilizing the product but also acts as a project "set up" environment for collaborators to test their code contributions.


2. UX Assets

This refers to diagrams and infographics such as user personas, service blueprints, as-is journeys and prioritisation grids. UX assets are data-driven, hence it will act as a solid reference point when improving or developing new features (Wang, 2016).

UX assets like service blueprints and user flows help developers or other contributors in tracking project versions and development phases. Service blueprints visually depict the service journey, highlighting touchpoints and interactions. Whereas user flows illustrate the steps users take to complete tasks. These assets ensure a user-centred approach, allowing developers to enhance the user experience and meet user expectations.

During my placement year, I created a service blueprint for the NHS's Test Ordering System. The service blueprint outlines all the pages within the Test Ordering System. Each page is tagged with a coloured circle that represents the different development phases each week (See screenshot for colour == development phase). The diagram served as a visual tool for the team to clearly understand and plan the tasks for the week. It provided a clear overview of the progress made, allowing for easy evaluation of the team's productivity we can pinpoint what is done and what is not.


Example of the service blueprint I made:



3. UI Assets

Contributing to UI Assets refers to contributing to the project's design system, visual assets and other assets related to the brand's visual identity. While UX assets like diagrams and infographics are generally more flexible in terms of contributing, contributing UI assets often requires stricter guidelines. Projects with an established brand identity may require contributors to follow specific visual guidelines to ensure design consistency and visual harmony, which is crucial for accessibility considerations (DesignerUp, 2023).

However, even if it's challenging to get an entirely new visual asset merged into an open-source project with an established brand identity, there are alternative ways to contribute to the visual aspect. This includes helping the community manage its design system by updating outdated designs and features or converting custom illustrations into icons.

As an example, IBM's design system called "Carbon" is an open-source project that allows contributors to help update their UI and build reusable components.


4. Outreach and Promotions

Outreach and Promotions refers to promoting the goal and functionalities of an open-source project. This can be done by writing blog posts, giving presentations, or organising events to raise awareness as a way attract more contributors or users (Scarlett, 2022). I believe it's essential to consider strategies to gain traction and attract more contributors and users to ensure the project's success and growth.

As an example, an open source project that I've contributed to this unit, MindsDB is open-source software that automates building machine learning models for cloud databases. The project in itself is very relevant to the advancements in technology today. Despite its relevance, it is still not a well-known software. The project often faces challenges in terms of recognition and user engagement to gather valuable user ratings and insights.

This lack of feedback and engagement from end users hampers the project's ability to leverage user insights for improving their software effectively (Seen from the screenshot below). Hence, outreach and promotion are essential to building a reputation for an open-source project.


In conclusion, even though open-source contribution is commonly known for code-based contributions, it is also important to recognise that there are also other ways to contribute and add value to the project beyond code. 




References

DesignerUp, D. (2023) Contributing to open source for designers: Complete Guide, DesignerUp. Available at: https://designerup.co/blog/contributing-to-open-source-for-designers/ (Accessed: 03 June 2023). 


Pottekkat, N. (2023) Non-code contributions to open source, Navendu Pottekkat. Available at: https://navendu.me/posts/non-code-contributions-to-open-source/ (Accessed: 03 June 2023). 


Scarlett, R. (2022) Attract contributors to your open source project with authenticity, Opensource.com. Available at: https://opensource.com/article/22/6/attract-contributors-open-source-project (Accessed: 03 June 2023). 


Wang, J. (2016) 8 non-code ways to contribute to open source, Opensource.com. Available at: https://opensource.com/life/16/1/8-ways-contribute-open-source-without-writing-code (Accessed: 03 June 2023). 




Post a Comment

© HNY Open Source Contributions. Design by HNY.