From bda943cdb4592841352e9ee16af86c072f31603a Mon Sep 17 00:00:00 2001 From: Xing Han Lu Date: Sat, 3 Nov 2018 01:56:15 -0400 Subject: [PATCH 1/4] Update contributing and code of conduct --- CHANGELOG.md | 3 +- CODE_OF_CONDUCT.md | 46 +++++++++++++++++++++++++ CONTRIBUTING.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 132 insertions(+), 1 deletion(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 825c32f0..fb4fcab5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1 +1,2 @@ -# Changelog +# 0.0.1 - 2018-11-03 +First pre-release version of dash-cytoscape. Still WIP, so prepare to see it break 🔧 \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..20617f51 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at chris@plot.ly. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..1fe33e19 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,84 @@ +# Contributing to dash-cytoscape + +## Getting Started + +Refer to the [readme](README.md) for installation and development instructions. + +## Coding Style + +Please lint any additions to Python code with `pylint` and `flake8`. + +## Pull Request Guidelines + +Use the [GitHub flow][] when proposing contributions to this repository (i.e. create a feature branch and submit a PR against the master branch). + +## Running the Tests + +_To be added_ + + +## Making a contribution +_For larger features, your contribution will have a higher likelihood of getting merged if you create an issue to discuss the changes that you'd like to make before you create a pull request._ + +1. Create a pull request and tag the Plotly team (`@plotly/dash_bio`) and tag / request review from [@xhlulu](https://github.com/xhlulu). +2. After a review has been done and your changes have been approved, create a prerelease and comment in the PR. Version numbers should follow [semantic versioning][]. To create a prerelease: + * Add `rc1` to `version.py` (`./dash/version.py`) e.g. `0.1.0rc1` + - If needed, ask @chriddyp to get PyPi package publishing access. + * Run `python setup.py sdist` to build a distribution zip. + * Check the `dist` folder for a `tar.gz` file ending with your selected version number. Double check that this version number ends with `rc#`, as to not mistakenly publish the package. + * Run `twine upload dist/`. +3. Comment in the PR with the prerelease version +4. Update the top-level comment to include info about how to install, a summary of the changes, and a simple example. + * This makes it easier for a community member to come in and try it out. As more folks review, it's harder to find the installation instructions deep in the PR + * Keep this top-level comment updated with installation instructions (e.g. the `pip install` command) +5. Make a post in the [Dash Community Forum][] + * Title it `":mega: Announcement! New - Feedback Welcome"` + * In the description, link to the PR and any relevant issue(s) + * Pin the topic so that it appears at the top of the forum for two weeks + +## [Checklists](http://rs.io/unreasonable-effectiveness-of-checklists/) +**Beginner tip:** _Copy and paste this section as a comment in your PR, then check off the boxes as you go!_ +### Pre-Merge checklist +- [ ] If changes are significant, a release candidate has been created and posted to Slack, the Plotly forums, and at the very top of the pull request. +- [ ] Two people have :dancer:'d the pull request. You can be one of these people if you are a Dash core contributor. + +### Post-Merge checklist +- [ ] You have tagged the release using `git tag v` _(for the contributor merging the PR)_. +- [ ] You have pushed this tag using `git push ` _(for the contributor merging the PR)_. +- [ ] You have deleted the branch. + +### Pre-Release checklist +- [ ] Everything in the Pre-Merge checklist is completed. (Except the last two if this is a release candidate). +- [ ] `git remote show origin` shows you are in the correct repository. +- [ ] `git branch` shows that you are on the expected branch. +- [ ] `git status` shows that there are no unexpected changes. +- [ ] `dash/version.py` is at the correct version. + +### Release Step +- `python setup.py sdist` to build. +- `twine upload dist/` to upload to PyPi. + +### Post-Release checklist +- [ ] You have closed all issues that this pull request solves, and commented the new version number users should install. +- [ ] If significant enough, you have created an issue about documenting the new feature or change and you have added it to the [Documentation] project. +- [ ] You have created a pull request in [Dash Docs] with the new release of your feature by editing that project's [`requirements.txt` file](https://github.com/plotly/dash-docs/blob/master/requirements.txt) and you have assigned `@chriddyp` to review. + +## Financial Contributions + +Dash, and many of Plotly's open source products, have been funded through direct sponsorship by companies. [Get in touch] about funding feature additions, consulting, or custom app development. + +[Dash Core Components]: https://dash.plot.ly/dash-core-components +[Dash HTML Components]: https://github.com/plotly/dash-html-components +[write your own components]: https://dash.plot.ly/plugins +[Dash Component Biolerplate]: https://github.com/plotly/dash-component-boilerplate +[issues]: https://github.com/plotly/dash-core-components/issues +[GitHub flow]: https://guides.github.com/introduction/flow/ +[eslintrc-react.json]: https://github.com/plotly/dash-components-archetype/blob/master/config/eslint/eslintrc-react.json +[contributors]: https://github.com/plotly/dash-core-components/graphs/contributors +[semantic versioning]: https://semver.org/ +[Dash Community Forum]: https://community.plot.ly/c/dash +[Confirmation Modal component]: https://github.com/plotly/dash-core-components/pull/211#issue-195280462 +[Confirmation Modal announcement]: https://community.plot.ly/t/announcing-dash-confirmation-modal-feedback-welcome/11627 +[Get in touch]: https://plot.ly/products/consulting-and-oem +[Documentation]: https://github.com/orgs/plotly/projects/8 +[Dash Docs]: https://github.com/plotly/dash-docs \ No newline at end of file From 7fa73e57c33035d7c645bb7723f2357635111eab Mon Sep 17 00:00:00 2001 From: Xing Han Lu Date: Sat, 3 Nov 2018 02:06:33 -0400 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 50 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fe33e19..dadc9719 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,18 +20,42 @@ _To be added_ ## Making a contribution _For larger features, your contribution will have a higher likelihood of getting merged if you create an issue to discuss the changes that you'd like to make before you create a pull request._ -1. Create a pull request and tag the Plotly team (`@plotly/dash_bio`) and tag / request review from [@xhlulu](https://github.com/xhlulu). -2. After a review has been done and your changes have been approved, create a prerelease and comment in the PR. Version numbers should follow [semantic versioning][]. To create a prerelease: - * Add `rc1` to `version.py` (`./dash/version.py`) e.g. `0.1.0rc1` - - If needed, ask @chriddyp to get PyPi package publishing access. - * Run `python setup.py sdist` to build a distribution zip. - * Check the `dist` folder for a `tar.gz` file ending with your selected version number. Double check that this version number ends with `rc#`, as to not mistakenly publish the package. - * Run `twine upload dist/`. -3. Comment in the PR with the prerelease version -4. Update the top-level comment to include info about how to install, a summary of the changes, and a simple example. - * This makes it easier for a community member to come in and try it out. As more folks review, it's harder to find the installation instructions deep in the PR - * Keep this top-level comment updated with installation instructions (e.g. the `pip install` command) -5. Make a post in the [Dash Community Forum][] +Create a pull request and tag the Plotly team (`@plotly/dash_bio`) and tag / request review from [@xhlulu](https://github.com/xhlulu). + +After a review has been done and your changes have been approved, create a prerelease and comment in the PR. Version numbers should follow [semantic versioning][]. + +To publish or create a prerelease: +1. Check `MANIFEST.in` has all of the extra files (like CSS) +2. Bump version numbers in `package.json`, update the `CHANGELOG.md`, and make a pull request +3. Once the pull request is merged into master: +4. Build +```npm run build:all``` +5. Create distribution tarball +```python setup.py sdist``` +6. Copy the tarball into a separate folder and try to install it and run the examples: +```cp dist/dash-cytoscape-0.0.1.tar.gz ../temp +cp usage.py ../temp +cd ../temp +source venv/bin/activate +pip install dash-cytoscape-0.0.1.tar.gz +python usage.py +``` +7. If the examples work, then publish: +```npm publish +twine upload dist/dash-cytoscape-0.0.1.tar.gz +``` +8. Tag your release with git: +```git tag -a 'v0.0.1' -m 'v0.0.1' +git push origin master --follow-tags +``` +9. Verify that the publish worked by installing it: +```cd ../temp +pip install dash-cytoscape==0.0.1 +python usage.py +``` + + +Make a post in the [Dash Community Forum][] * Title it `":mega: Announcement! New - Feedback Welcome"` * In the description, link to the PR and any relevant issue(s) * Pin the topic so that it appears at the top of the forum for two weeks @@ -81,4 +105,4 @@ Dash, and many of Plotly's open source products, have been funded through direct [Confirmation Modal announcement]: https://community.plot.ly/t/announcing-dash-confirmation-modal-feedback-welcome/11627 [Get in touch]: https://plot.ly/products/consulting-and-oem [Documentation]: https://github.com/orgs/plotly/projects/8 -[Dash Docs]: https://github.com/plotly/dash-docs \ No newline at end of file +[Dash Docs]: https://github.com/plotly/dash-docs From 1cfb8075bf7a068292b1530948afab9c52bd11d9 Mon Sep 17 00:00:00 2001 From: Xing Han Lu Date: Sat, 3 Nov 2018 02:07:20 -0400 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dadc9719..cb28b7ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,7 @@ Create a pull request and tag the Plotly team (`@plotly/dash_bio`) and tag / req After a review has been done and your changes have been approved, create a prerelease and comment in the PR. Version numbers should follow [semantic versioning][]. To publish or create a prerelease: + 1. Check `MANIFEST.in` has all of the extra files (like CSS) 2. Bump version numbers in `package.json`, update the `CHANGELOG.md`, and make a pull request 3. Once the pull request is merged into master: From 10b0e93361cd064dfe68f3889e6d3d5833e9f8b4 Mon Sep 17 00:00:00 2001 From: Xing Han Lu Date: Sat, 3 Nov 2018 02:07:46 -0400 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb28b7ad..fc249469 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to dash-cytoscape +# Contributing to Dash Cytoscape ## Getting Started