Add a short note to help new contributors get started by Tithi234 · Pull Request #736 · realpython/materials
realpython / materials Public
-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Open
Open
Conversation
Tithi234
commented
Feb 10, 2026
Tithi234
commented
Added note for new contributors about starting with documentation improvements and running code style checks.
Where to put new files:
- New files should go into a top-level subfolder, named after the article slug. For example:
my-awesome-article
How to merge your changes:
- Make sure the CI code style tests all pass (+ run the automatic code formatter if necessary).
- Find an RP Team member on Slack and ask them to review & approve your PR.
- Once the PR has one positive ("approved") review, GitHub lets you merge the PR.
- 🎉
Added note for new contributors about starting with documentation improvements and running code style checks.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment