esri/contributing

Guidelines for contributing to Esri open source projects

contributing's Issues

Writing to Feature Services

Will a future version (or does the current version) of Koop support writing to repositories vi the Feature Service endpoints exposed by Koop?

Changing copyright year from 2013 to 2015 in the website

I guess the year in the footer needs to be updated in the website

mouse scroll wheel zoom

Is map.enableScrollWheelZoom() supported?

as an employee, how do I join Esri's Organizations on GitHub?

In order to be added to one of Esri's organizations (so that you'll appear here):

1. Create a new GitHub account
   • Account: jDoe (not jDoe-esri)
   • Name: Jane Doe
   • Company: Esri
   • A Gravatar is strongly recommended
2. Use your @esri.com email address to send a message to [email protected] requesting to join our Organizations.

The Esri Organization is for repositories that we are ready to make available to the public.

Should I continually update the year of my project's copyright?

No. This is not necessary.

Copyright (c) 2017 > Copyright (c) 2018

Using a range is a helpful way to indicate to other developers both when a project began and the fact that it is still being actively maintained, but this is also not required.

Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.

This is because copyright provides legal protection into the future and its primary purpose is to communicate the year of initial publication.

(reference)

Can i contribute code written by someone else?

Please do not contribute code you did not write yourself unless you are certain you have the legal ability to do so.

All contributed code must be redistributable under the Apache-2.0 License.

create a FAQ

@bradleywertman and i are going to take a stab at adding an FAQ wiki to answer common questions

• how do i join the Esri/ArcGIS organizations
• how do i set up git on my own machine
  • github for desktop
  • sourcetree
• how can i keep my fork in sync
• how to submit a pull request

Does Esri have a 'code of conduct'?

Yes we do!

We expect folks that participate in both our online and IRL communities to be kind and considerate of others. More details can be found in the document below:

http://www.esri.com/events/code-of-conduct

For Esri open source project maintainers, the template file below can be used as a reference:
https://github.com/Esri/contributing/blob/master/CODE_OF_CONDUCT.md

Error found

Class "MapOptionsSample" has a few errors, first: class name extends controlPanel and second on line 229, "OptionsWindow". both cannot be revolved to a type.

BasicMapTool properties does not exist

I'm using VS 2015 Professional with ArcGIS Pro SDK 2; building the BasicMapTool project returns errors for OverlayControlCanResize and OverlayControlPositionRatio, says the name does not exist in the current context. These are not properties of the OverlayControl....

public BasicMapTool() : base() {
    this.OverlayControlID = "BasicMapTool_BasicEmbeddableControl";
    
    //Embeddable control can be resized
    OverlayControlCanResize = true;
    // //Specify ratio of 0 to 1 to place the control
    OverlayControlPositionRatio = new System.Windows.Point(0, 0); //top left
}

Update README copyright date

Root README license copyright date referencing 2016, should be updated to 2017.

as an employee, how do I open source something new?

to get your project up to snuff you'll need to complete the steps below:

add a LICENSE

our open source license of choice is Apache-2.0

You'll need to

1. include a LICENSE file in the root of the project.

2. paraphrase the license in your README.md and link to the full text.

   ### License
   
   Copyright (c) 2017-2018 Esri
   
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
   
   > http://www.apache.org/licenses/LICENSE-2.0
   
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
   
   A copy of the license is available in the repository's [LICENSE](./LICENSE) file.

3. You'll also need to include a copyright notice in your raw source.

   /* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
    * Apache-2.0 */

add a CONTRIBUTING.md file

Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing).

This provides a breadcrumb for all new contributors to learn more about our companies guidelines for open source when the open a new issue or pull request.

add a README.md

A README explains the purpose of the project and include screenshots or .gifs (and ideally a link to a live demo) so that folks can see the code in action.

You should provide instructions to help developers get started using the code.

you can reference this README_TEMPLATE.md if you need a sample.

• LICENSE
  • copyright notice in source code
• README.md
  • explain project
  • screenshots/animations
  • live demo
• CONTRIBUTING.md

ready?

once you've completed the checklist you're ready to send a message to [email protected] and ask them to move your project into our https://github.com/Esri organization.

---

Bonus Points

add search topics

In https://esri.github.io/ we highlight projects from the categories below and give search suggestions using predefined keywords.

• data-management
• spatial-analysis
• publishing-sharing
• web-development
• native-development

Because of this, we recommend adding as many topics from this list as make sense.

reference: https://help.github.com/articles/about-topics/

add a CHANGELOG.md

"A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project." - https://keepachangelog.com/en/1.0.0/

add a CODE_OF_CONDUCT.md

tests

Adding unit and or integration tests to your project instills confidence that your code delivers on its promises.

CI

use Travis/Jenkins or another Continuous Integration tool to ensure that your test suite is run automatically each time someone makes a contribution.

fifteen pieces of flair

badges aren't required, but they are fun! ::sparkling_heart::.

Explicit name "geoportal" in criteria.jsp

It seems ther's an explicit reference to the webapp name in file \catalog\search\criteria.jsp:

Line 1499:

Failed to execute (CreateRelationshipClass)

I did test all the examples and all of them fail in the same spot. My main focus is on XML.

ERROR 000177: Relationship classes can only be created in the same database that contains the feature classes or tables.
Failed to execute (CreateRelationshipClass).

The procedure
creates a temporary gdb,
inserts into that the line_segments feature class from the real database
imports the activity records from XML
tries to create the relationship class in that temporary gdb and fails with the error.

Missing guidance about new repositories

Hi. These guidelines describe how to contribute to existing repositories (by forking them and sending pull requests), but what if I want to make a new repository and make it available through esri.github page?I'd like to share some of my arcpy helper/wrapper functions and esri.github seems the best place to put it. Can you please update the guidelines to explain what should I do?
Many thanks, Filip.

wanted: additional maintainers/contributors (all experience levels welcome)

no development experience required for this one. having additional eyes on this project would be extremely helpful.

if you're willing, even sporadically, to review Pull Requests and/or help keep the documentation up to date, please holler.

if you'd like to get involved, but need a little guidance getting familiar with git/github, that would be great too!

Suggested Style Guides?

Are there any particular code formatting / styling guidelines contributors should be aware of?