Add Contribution guideline in Readme #127
Conversation
|
Rather, that's what the |
PgBiel
added
documentation
As @PgBiel said, these instructions should go in the |
|
@naveen521kk this is a great idea! Please address my comments :) |
|
Also, it would be good to include language about pulling from upstream/master right before PRing, resolving merge conflicts locally and only then submitting the PR |
There was a problem hiding this comment.
imo, most people here will know how to use Git, so first and foremost we should specify what we want from PRs. More specifically:
- If code changes are being made, please include documentation following the guidelines in the Wiki (typings are also welcome, but we can probably do them for you, given the documentation);
- (For the maintainers of this repo) Label PRs appropriately;
- Link relevant issues;
- Ensure compatibility with the latest changes in the repo.
|
So, should I add it in the top? @PgBiel |
|
yes |
CONTRIBUTING.md
Outdated
| As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it. | ||
|
|
||
| 1. First, make a fork of either this Repository. | ||
| 2. Then clone the repository you forked by the command below. |
There was a problem hiding this comment.
| 2. Then clone the repository you forked by the command below. | |
| 2. Then, clone the repository you forked using the command below (bash/zsh). |
|
Anything else to be done? |
|
Just waiting for @PgBiel 's approval :) |
|
…into contrib-guide
|
I redid it. That was while |
|
Think so |
4 participants
Fix #124
In this PR, I have added contributing guidelines for Dev in ReadMe.