Welcome to the second chapter! In the previous chapter, AGENTS.md, we learned how to teach AI robots to understand our project.
Now, we need to shift our focus to humans.
Open Source projects like ML-For-Beginners are global classrooms. Anyone from anywhere can come in to learn or teach. But just like a real classroom or a playground, things can get messy if there are no rules.
Imagine you are playing a game of soccer in a public park.
In software projects, this "stranger" could be someone writing mean comments, spamming the discussion board, or being disrespectful to beginners.
The Solution: CODE_OF_CONDUCT.md.
This file is the Rule Book for the playground. It tells everyone: "You are welcome here, but you must be nice. If you aren't nice, here is what will happen."
While most files in this repository contain Python code for machines, CODE_OF_CONDUCT.md contains Social Code for people.
It establishes three main things:
Since ML-For-Beginners is a Microsoft project, we use the standard Microsoft Open Source Code of Conduct. This ensures that the same high standard of safety applies here as it does in huge professional projects.
You don't "run" this file like a script. You simply place it in the root folder of your project.
However, its "usage" happens when a human decides to interact with the community. Let's look at what is inside the file.
Here is a simplified view of what the text inside looks like. It is written in Markdown so it looks pretty on the web.
# Microsoft Open Source Code of Conduct
## Our Pledge
We are committed to making participation in this project
a harassment-free experience for everyone.
## Standards
* **Do:** Use welcoming and inclusive language.
* **Don't:** Trolling or insulting/derogatory comments.
## Reporting Issues
If you see bad behavior, contact opencode@microsoft.com.
Explanation:
You might wonder, "Does this file actually do anything technically?"
Yes! Platforms like GitHub treat this file specially. When you have a CODE_OF_CONDUCT.md in your root folder, GitHub integrates it into the user interface.
Here is what happens when a new student tries to ask a question or report a bug in the project.
Because the file exists, the platform proactively reminds the human to be polite before they even type a word.
Technically, this is a static file. However, it acts as a Governance Anchor.
In this specific project, the file is located at the top level so it covers every lesson, from 2-Regression to 9-Real-World.
Here is how we might link to it if we were building a website for our project:
<!-- Footer of our documentation website -->
<footer>
<a href="CODE_OF_CONDUCT.md">
Community Guidelines
</a>
<p>Please be respectful.</p>
</footer>
Explanation:
If you are new to coding, you might feel intimidated. You might worry: "What if I ask a stupid question and people laugh at me?"
The CODE_OF_CONDUCT.md is there to protect you.
In this chapter, we learned that CODE_OF_CONDUCT.md is the "Constitution" of our project. It defines how we treat each other.
Now that we have established the rules for our Robots (AGENTS.md) and the rules for our Humans (CODE_OF_CONDUCT.md), we are finally ready to start our Machine Learning journey!
Get your Python ready, because we are diving into the history and basics of ML next.
Generated by Code IQ