DEV Community

loading...
For Devs community

CONTRIBUTING: PnPjs

floord profile image Floor Drees ・2 min read

Leading up to (and during) the month of October, we want to help you discover open source projects to work on, and put your Hacktoberfest contributions to excellent use. Meet Patrick Rodgers & Julie Turner, co-maintainers for the PnPjs project.

Check out this page regularly for more interviews with contributors & maintainers

What can you tell us about your project?
PnPjs is a fluid JavaScript library that is designed to help you make requests to SharePoint and Microsoft Graph. We've been around since 2016, so that's 4.5 years of great, fun work with the community. Right now we process about 9.2 billion requests to SharePoint online, coming out of about 19.000 tenants.

What contributions are you welcoming?
We'd love for people to contribute to Docs, helping us clarify and streamline documentation so that people can consume the library better. We also list Issues in our repo that are an opportunity to contribute. But also if you have ideas, things you'd like see as part of the library, we welcome that as well! Submit your PR and we will review and if it's a good fit we'll absolutely include your addition in the next version - and we release on a monthly cadence.

What skills do people need to contribute?
From a skills perspective it's really good if you have some general understanding of how to use TypeScript and build client-side solutions - you'll need to be able to write TS, and review the library that's already there, so that you can extend it. It's build in such a way that it has a core set of functionality, and the way that we extend it is to build on top of that. It takes a little bit to understand that (core set of functionality), but you can have a look at some of the other features of the library to help you get started on extending PnPjs for whatever RESTful endpoints we're not yet covering, or for things we could do a little better.

And if you have questions on getting started contributing, of course you could post those on our Issues list, and we'll do our best to help you out!

How do folks get started?
In order to get started, you can check out the Contribution guidelines, which give you step by step guidance on how to get your workstation set up. It's also our Docs, so more information on how to use the library can also be found there.

Check contributing.today regularly for more interviews with contributors & maintainers, as well as online events to help you get involved in open source.

Discussion

pic
Editor guide