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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
CONTRIBUTING.md #1060
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Contributing to training-kit
馃帀 Thank you for taking the time to contribute and for seeking out these instructions. We 鉂わ笍 community contributions to these materials.
Code of Conduct
This project and everyone who participates in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
What should I know before I get started?
The goal of these resources
These materials are designed to help those new to Git, GitHub and software development as a whole. By using these materials, we hope users will:
Types of contributions we love
We're always looking for contributions to help improve these resources. This includes:
How to contribute
Report a bug
Oops, thanks for finding that! If you know how to fix it, please feel free to fork the repository and submit a change via Pull Request.
If you aren't sure how to fix it or just don't have time, we invite you to open a new Issue. Please be sure to provide information, so we can recreate the error.
Translate existing resources
Several community members have been kind enough to translate the Git Cheat Sheets into various languages. At this time, we are only set up to serve the cheat sheets in various languages (but maybe you can help us change that 馃槈). If you are planning to contribute a translation, please do the following:
main
branch of this repository.When this process is complete, we will be happy to merge the completed document.
Contribute something new
Whether you have an idea to make it better, or want to contribute a whole new course or resource ... we 鉂わ笍 new ideas! We invite you to open a new Issue to talk about it before you invest too much time. Of course, if you want to experiment first, you can fork this repository and submit your idea via a Pull Request.
When you are contributing something new, we ask you to be familiar with our content philosophy, the structure of the repository, and building Jekyll sites locally. See the sections below for more information.
Not sure where to start?
If you just want to help out, but don't have a particular change in mind, check out the open issues for projects you can tackle, review an open pull request, or check out the project ROADMAP.
Styling content
This site uses GitHub's CSS toolkit called Primer. It's easy to use, and if your contribution requires some design or front-end work you should check out the Primer Docs.
For writing style guides, we lean on the GitHub Brand Guide. The Content section is a great place to start.
Building and testing
When you are ready to test your changes, you will want to build the repository locally. This is fully automated through a series of shell scripts based the scripts to rule them all!
To build the materials do the following:
script/bootstrap
to install the dependenciesscript/build
to build the sitescript/server
http://127.0.0.1:4000/
.The text was updated successfully, but these errors were encountered: