From the course: 25 GitHub Configuration Files You Should Be Using

Unlock this course with a free trial

Join today to access over 25,300 courses taught by industry experts.

CONTRIBUTING.md: How to contribute to a project

CONTRIBUTING.md: How to contribute to a project

From the course: 25 GitHub Configuration Files You Should Be Using

Start my 1-month free trial Buy for my team

CONTRIBUTING.md: How to contribute to a project

“

- [Instructor] With the contributing markdown file, you can explain to people how you expect them to work with the project. You can explain your process, for example. Tell them you want to open an issue with a detailed explanation before they start working on any code changes. Then you can have a discussion and guide them to a solution, instead of them sending in a multi-thousand lines of code chain set. Your process could then also be to send in a pull request after this and to communicate inside of the pull request. This is a very common way of working in open source projects. A link to the contributing file will be prominently visible the first time the user starts to contribute to your project. So on the creation of their first issue or pull request. It is also shown on the discussions page when they first contribute to a discussion. After their first contribution, a smaller link will be visible at the bottom of the…

Contents