From 6023c413ab1762e0a1bb2476ed46eb4be2af7944 Mon Sep 17 00:00:00 2001 From: Mariana Meireles Date: Tue, 6 Sep 2022 21:35:20 +0000 Subject: [PATCH] Update CONTRIBUTING.md (#728) * Update CONTRIBUTING.md Adding docs on how to make a pr * Rewording so ideas are clearer --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72c6398f..00e7399a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,6 +73,28 @@ If you have questions about the project, using PyScript, or anything else, pleas Now that node and npm have both been updated `make setup` should work, and you can continue [setting up your local environment](#setting-up-your-local-environment) without problems (hopefully). +## Creating a Pull Request + +After you fork PyScript make sure to add a new remote. You can do that using the command: + +``` +git remote add remote_nickname remote_url +``` + +You should have one remote that corresponds to your local repository and one remote that corresponds the upstream PyScript repository. + +We recommend you to create a new local branch and develop your changes in this branch. You can do that by using: + +``` +git checkout -b branch_name #creates new branch +git checkout branch_name #goes to branch +``` + +It's not mandatory but it's advisible to have one issue that is related to your PR, the more information you give and the clearer you can communicate your ideas the faster maintainers will be able to review your changes and merge your PR. + +Please try to keep the changes on your PR within the issue's scope. In case you don't have a related issue, limit the your PR's scope in a way that a short sentence summarizes its contents. This sentence should be the name of your PR. If you can't think of a sentence that summarizes your PR well, might be a sign that you need to split it in two or more PRs! + + ## Places to start If you would like to contribute to PyScript, but you aren't sure where to begin, here are some suggestions.