diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d414b71275..a3579c90d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,7 @@ 2. (For the maintainers of this repo) Label PRs appropriately. 3. Link relevant issues. 4. Ensure compatibility with the latest changes in the repo. +5. After you've made your changes, please test them out thoroughly. If the repository has any example code or code exclusively used for testing, please test your changes against those. If you have added new features, consider writing and contributing to a test for that feature to ensure it works properly. ## Contributing to the Manim Community Fork - General instructions @@ -33,6 +34,8 @@ As this is a Fork of [Manim by 3b1b](https://github.com/3b1b/manim), contributin 4. After that, you can make your changes to the repo's files (the code is in the `manim` directory). Then, you can commit said changes. +> As stated in the General Contribution Guidelines, make sure to test your changes against the example scenes in the `example_scenes` directory and test scenes in the `tests` directory, and add a new test in the `tests` directory for your new feature if you've made one. + > Note: if your Pull Request doesn't change any of the actual code, please add `[skip ci]` to your commit message for Travis to ignore it. 5. Finally, instead of typing in `git push`, enter the command below.