-
Notifications
You must be signed in to change notification settings - Fork 32
Github Tips for SSVC contributors
The SSVC project uses Github features to interact with the community. Although many Github features are more geared toward software development, the tools Github provides are also useful for collaborative development of documentation and other types of content. We realize that not everyone is familiar with Github, so we have included some tips here to help you get started.
It is not necessary to have a Github account to use the SSVC project, but it is helpful if you want to contribute to the project. Github offers free accounts, so no payment is required to contribute to the project.
No, you do not need to know how to code to contribute to the SSVC project. We welcome contributions from anyone who is interested in helping to improve the project, regardless of technical background. Many of the contributions we are looking for are related to writing, editing, and organizing content. This can include things like fixing typos, improving the clarity of explanations, and adding new examples or tutorials.
While a basic understanding of Git is helpful, it is not necessary to know how to use Git to contribute to the SSVC project. Github provides a web-based interface for editing and creating content, so you can contribute to the project without needing to use Git directly. Of course, more technical contributions may require some familiarity with Git, but it is not a requirement for all types of contributions.
Our primary methods for contributing to the SSVC project are through creating issues, pull requests, and discussions.
Github itself provides a lot of documentation on how to use its features. We're not going to try to replicate all of that here, but we will provide some pointers to the most relevant Github documentation for contributing to the SSVC project.
A broad overview of Github features is available at:
Here we've highlighted a few areas we think you might find helpful: