You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 3.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. # Contributing
  2. 1. Sign one of the contributor license agreements below.
  3. 1. Get the package:
  4. `go get -d google.golang.org/appengine`
  5. 1. Change into the checked out source:
  6. `cd $GOPATH/src/google.golang.org/appengine`
  7. 1. Fork the repo.
  8. 1. Set your fork as a remote:
  9. `git remote add fork git@github.com:GITHUB_USERNAME/appengine.git`
  10. 1. Make changes, commit to your fork.
  11. 1. Send a pull request with your changes.
  12. The first line of your commit message is conventionally a one-line summary of the change, prefixed by the primary affected package, and is used as the title of your pull request.
  13. # Testing
  14. ## Running system tests
  15. Download and install the [Go App Engine SDK](https://cloud.google.com/appengine/docs/go/download). Make sure the `go_appengine` dir is in your `PATH`.
  16. Set the `APPENGINE_DEV_APPSERVER` environment variable to `/path/to/go_appengine/dev_appserver.py`.
  17. Run tests with `goapp test`:
  18. ```
  19. goapp test -v google.golang.org/appengine/...
  20. ```
  21. ## Contributor License Agreements
  22. Before we can accept your pull requests you'll need to sign a Contributor
  23. License Agreement (CLA):
  24. - **If you are an individual writing original source code** and **you own the
  25. intellectual property**, then you'll need to sign an [individual CLA][indvcla].
  26. - **If you work for a company that wants to allow you to contribute your work**,
  27. then you'll need to sign a [corporate CLA][corpcla].
  28. You can sign these electronically (just scroll to the bottom). After that,
  29. we'll be able to accept your pull requests.
  30. ## Contributor Code of Conduct
  31. As contributors and maintainers of this project,
  32. and in the interest of fostering an open and welcoming community,
  33. we pledge to respect all people who contribute through reporting issues,
  34. posting feature requests, updating documentation,
  35. submitting pull requests or patches, and other activities.
  36. We are committed to making participation in this project
  37. a harassment-free experience for everyone,
  38. regardless of level of experience, gender, gender identity and expression,
  39. sexual orientation, disability, personal appearance,
  40. body size, race, ethnicity, age, religion, or nationality.
  41. Examples of unacceptable behavior by participants include:
  42. * The use of sexualized language or imagery
  43. * Personal attacks
  44. * Trolling or insulting/derogatory comments
  45. * Public or private harassment
  46. * Publishing other's private information,
  47. such as physical or electronic
  48. addresses, without explicit permission
  49. * Other unethical or unprofessional conduct.
  50. Project maintainers have the right and responsibility to remove, edit, or reject
  51. comments, commits, code, wiki edits, issues, and other contributions
  52. that are not aligned to this Code of Conduct.
  53. By adopting this Code of Conduct,
  54. project maintainers commit themselves to fairly and consistently
  55. applying these principles to every aspect of managing this project.
  56. Project maintainers who do not follow or enforce the Code of Conduct
  57. may be permanently removed from the project team.
  58. This code of conduct applies both within project spaces and in public spaces
  59. when an individual is representing the project or its community.
  60. Instances of abusive, harassing, or otherwise unacceptable behavior
  61. may be reported by opening an issue
  62. or contacting one or more of the project maintainers.
  63. This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
  64. available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
  65. [indvcla]: https://developers.google.com/open-source/cla/individual
  66. [corpcla]: https://developers.google.com/open-source/cla/corporate