honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md 

Asking contributors to point to `master` branch
This commit is contained in:
Hugo Bernier 2020-04-03 11:45:10 -04:00 committed by GitHub
parent 3e2f2baa6e
commit 1c60fa426c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
.github/CONTRIBUTING.md vendored
View File

@ -1,6 +1,6 @@
# Contribution Guidance
If you'd like to contribute to this repository, please read the following guidelines. Contributors are more than welcome to share your learnings with others from centralized location.
If you'd like to contribute to this repository, please read the following guidelines. Contributors are more than welcome to share their learnings with others in this centralized location.
## Code of Conduct
@ -20,45 +20,45 @@ If you have questions about how to use SharePoint Framework or any of the provid
Whenever you are submitting any changes to the SharePoint repositories, please follow these recommendations.
* Always fork repository to your own account for applying modifications
* Do not combine multiple changes to one pull request, please submit for example any samples and documentation updates using separate PRs
* If you are submitting multiple samples, please create specific PR for each of them
* Always fork the repository to your own account before making your modifications
* Do not combine multiple changes to one pull request. For example, submit any samples and documentation updates using separate PRs
* If you are submitting multiple samples, please create a specific PR for each of them
* If you are submitting typo or documentation fix, you can combine modifications to single PR where suitable
## Sample Naming and Structure Guidelines
When you are submitting a new sample, it has to follow up below guidelines
* You will need to have a README file for your contribution, which is based on [provided template](../samples/README-template.md) under the Samples folder. Please copy this template and update accordingly. README has to be named as README.md with capital letters.
* You will need to have a picture of the web part in practice in the README file ("pics or it didn't happen"). Preview image must be located in /assets/ folder in the root your you solution.
* README template contains specific tracking image as a final entry in the page with img tag by default to https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template. This is transparent image, which is used to track popularity of individual samples in GitHub.
* Updated the image src element according with repository name and folder information. If your sample is for example in samples folder and named as react-todo, src element should be updated as https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-todo
* If you find already similar kind of sample from the existing samples, we would appreciate you to rather extend existing one, than submitting a new similar sample
* If you for example use Office Graph with React, please rather add new web part to already existing solution, rather than introducing completely new solution
* When you update existing samples, please update also README accordingly with information on provided changes and with your author details
* When you are submitting new sample solution, please name the sample solution folder accordingly
* Folder should start by identifying JS library used - like "react-", "angular-", "knockout-"
* If you are not using any specific JS library, please use "js-" as the prefix for your sample
* Do not use words "sample", "webpart" or "wb" in the folder or sample name - these are samples for client-side web parts repository
* You will need to have a `README.md` file for your contribution, which is based on [the provided template](../samples/README-template.md) under the `samples` folder. Please copy this template to your project and update it accordingly. Your `README.md` must be named exactly `README.md` -- with capital letters -- as this is the information we use to make your sample public.
* You will need to have a screenshot picture of your sample in action in the `README.md` file ("pics or it didn't happen"). The preview image must be located in the `/assets/` folder in the root your you solution.
* The `README` template contains a specific tracking image at the bottom of the file with an `img` tag, where the `src` attribute points to `https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template`. This is a transparent image which is used to track viewership of individual samples in GitHub.
* Update the image `src` attribute according with the repository name and folder information. For example, if your sample is named `react-todo` in the `samples` folder, you should update the `src` attribute to `https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-todo`
* If you find an existing sample which is similar to yours, please extend the existing one rather than submitting a new similar sample
* For example, if you use Office Graph with React, please add a new web part to the existing solution, rather than introducing a completely new solution
* When you update existing samples, please update also `README.md` file accordingly with information on provided changes and with your author details
* When submitting a new sample solution, please name the sample solution folder accordingly
* Folder should start by identifying JS library used - like `react-`, `angular-`, `knockout-`
* If you are not using any specific JS library, please use `js-` as the prefix for your sample
* Do not use words such as `sample`, `webpart` or `wp` in the folder or sample name - these are samples for client-side web parts repository
* If your solution is demonstrating multiple technologies, please use functional terms as the name for the solution folder
* Do not use period/dot in the folder name of the provided sample
## Submitting Pull Requests
Here's a high level process for submitting new samples or updates to existing ones.
Here's a high-level process for submitting new samples or updates to existing ones.
1. Sign the Contributor License Agreement (see below)
1. Fork this repository [SharePoint/sp-dev-fx-webparts](https://github.com/SharePoint/sp-dev-fx-webparts) to your GitHub account
1. Create a new branch off the `master` branch for your fork for the contribution
1. Include your changes to your branch
1. Commit your changes using descriptive commit message * These are used to track changes on the repositories for monthly communications
1. Create a pull request in your own fork and target `dev` branch
1. Fill up the provided PR template with the requested details
2. Fork this repository [SharePoint/sp-dev-fx-webparts](https://github.com/SharePoint/sp-dev-fx-webparts) to your GitHub account
3. Create a new branch from the `master` branch for your fork for the contribution
4. Include your changes to your branch
5. Commit your changes using descriptive commit message * These are used to track changes on the repositories for monthly communications
6. Create a pull request in your own fork and target the `master` branch
7. Fill up the provided PR template with the requested details
Before you submit your pull request consider the following guidelines:
* Search [GitHub](https://github.com/SharePoint/sp-dev-fx-webparts/pulls) for an open or closed Pull Request
that relates to your submission. You don't want to duplicate effort.
which relates to your submission. You don't want to duplicate effort.
* Make sure you have a link in your local cloned fork to the [SharePoint/sp-dev-fx-webparts](https://github.com/SharePoint/sp-dev-fx-webparts):
```shell
@ -105,9 +105,9 @@ Before you submit your pull request consider the following guidelines:
git push origin react-taxonomypicker
```
## Merging your Existing Github Projects with this Repository
## Merging your Existing GitHub Projects with this Repository
If the sample you wish to contribute is stored in your own Github repository, you can use the following steps to merge it with the this repository:
If the sample you wish to contribute is stored in your own GitHub repository, you can use the following steps to merge it with this repository:
* Fork the `sp-dev-fx-webparts` repository from GitHub
* Create a local git repository
@ -118,14 +118,14 @@ If the sample you wish to contribute is stored in your own Github repository, yo
git init
```
* Pull your forked copy of sp-dev-fx-webparts into your local repository
* Pull your forked copy of `sp-dev-fx-webparts` into your local repository
```shell
git remote add origin https://github.com/yourgitaccount/sp-dev-fx-webparts.git
git pull origin dev
git pull origin master
```
* Pull your other project from github into the samples folder of your local copy of sp-dev-fx-webparts
* Pull your other project from GitHub into the `samples` folder of your local copy of `sp-dev-fx-webparts`
```shell
git subtree add --prefix=samples/projectname https://github.com/yourgitaccount/projectname.git master
@ -134,12 +134,12 @@ If the sample you wish to contribute is stored in your own Github repository, yo
* Push the changes up to your forked repository
```shell
git push origin dev
git push origin master
```
## Signing the CLA
Before we can accept your pull requests you will be asked to sign electronically Contributor License Agreement (CLA), which is prerequisite for any contributions to PnP repository. This will be one time process, so for any future contributions you will not be asked to re-sign anything. After the CLA has been signed, our PnP core team members will have a look on your submission for final verification of the submission. Please do not delete your development branch until the submission has been closed.
Before we can accept your pull requests you will be asked to sign electronically Contributor License Agreement (CLA), which is a pre-requisite for any contributions all PnP repositories. This will be one-time process, so for any future contributions you will not be asked to re-sign anything. After the CLA has been signed, our PnP core team members will have a look at your submission for a final verification of the submission. Please do not delete your development branch until the submission has been closed.
You can find Microsoft CLA from the following address - https://cla.microsoft.com.