Changeset View
Changeset View
Standalone View
Standalone View
docs/next/src/pages/community/contributing.mdx
| import { DynamicMetaTags } from 'components/MetaTags'; | import { DynamicMetaTags } from 'components/MetaTags'; | ||||||||||||
| <DynamicMetaTags | <DynamicMetaTags | ||||||||||||
| title="Contributing | Dagster" | title="Contributing | Dagster" | ||||||||||||
| description="Contributions are welcome and are greatly appreciated. Here's the contribution guide." | description="Contributions are welcome and are greatly appreciated. Here's the contribution guide." | ||||||||||||
| /> | /> | ||||||||||||
| # Contributing | # Contributing | ||||||||||||
| We would love to see community members get as involved. | |||||||||||||
rexledesmaUnsubmitted Done Inline Actions
rexledesma: | |||||||||||||
catherinewuUnsubmitted Done Inline ActionsPrefer present tense: "We love to our community members get involved!" catherinewu: Prefer present tense: "We love to our community members get involved!" | |||||||||||||
| If you are planning to contribute to Dagster, you will first need to set | If you are planning to contribute to Dagster, you will first need to set | ||||||||||||
| up a local development environment. | up a local development environment. | ||||||||||||
| ## Environment Setup | ## Environment Setup | ||||||||||||
| 1. Install Python. Python 3.6 or above recommended, but our CI/CD | 1. Install Python. Python 3.6 or above recommended, but our CI/CD | ||||||||||||
| pipeline currently tests against up-to-date patch versions of Python | pipeline currently tests against up-to-date patch versions of Python | ||||||||||||
| 3.6, 3.7 and 3.8. | 3.6, 3.7 and 3.8. | ||||||||||||
| ▲ Show 20 Lines • Show All 106 Lines • ▼ Show 20 Lines | |||||||||||||
| docstrings from the library files. The `.rst` files can be found in the `docs/sections/api/apidocs` | docstrings from the library files. The `.rst` files can be found in the `docs/sections/api/apidocs` | ||||||||||||
| directory. | directory. | ||||||||||||
| If you change any `.rst` files, be sure to run the following command in the `docs` directory: | If you change any `.rst` files, be sure to run the following command in the `docs` directory: | ||||||||||||
| ```bash | ```bash | ||||||||||||
| make buildnext | make buildnext | ||||||||||||
| ``` | ``` | ||||||||||||
| ## Closing Issues | |||||||||||||
catherinewuUnsubmitted Done Inline ActionsSuggest: "Picking a Github Issue" catherinewu: Suggest: "Picking a Github Issue" | |||||||||||||
| We encourage you to start with a issue labeled with the tag | |||||||||||||
catherinewuUnsubmitted Done Inline Actions"an issue" catherinewu: "an issue" | |||||||||||||
| [`good first issue`](https://github.com/dagster-io/dagster/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | |||||||||||||
Done Inline Actions
just to highlight it rexledesma: just to highlight it | |||||||||||||
Done Inline ActionsI had trouble running docs site locally for some reason ☹️. Will review the whole page again tomorrow and revise it. yichendai: I had trouble running docs site locally for some reason ☹️. Will review the whole page again… | |||||||||||||
| in the [Github issue board](https://github.com/dagster-io/dagster/issues), | |||||||||||||
catherinewuUnsubmitted Done Inline Actions"in the" -> "on the" catherinewu: "in the" -> "on the" | |||||||||||||
| to get familiar with our codebase as a first-time contributor. | |||||||||||||
| Then, you can work on the issue labeled as [`good second issue`](https://github.com/dagster-io/dagster/labels/good%20second%20issue) | |||||||||||||
Done Inline Actions
it's weird how this is kebab case (looks like it is kebab case in our issues board). Consider standardizing it to "good second issue", like "good first issue"? rexledesma: it's weird how this is kebab case (looks like it is kebab case in our issues board). Consider… | |||||||||||||
Done Inline ActionsYes! this also reminds me of fixing the label in github yichendai: Yes! this also reminds me of fixing the label in github | |||||||||||||
| which is more like a medium task. | |||||||||||||
| When you are ready for more of a challenge, you can tackle issues with the | |||||||||||||
Done Inline Actions
fixed typo, and added link to issues sorted by emojis rexledesma: fixed typo, and added link to issues sorted by emojis | |||||||||||||
| [most 👍 reactions](https://github.com/dagster-io/dagster/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc). | |||||||||||||
catherinewuUnsubmitted Done Inline ActionsSince there are not that many issues with 👍 emoji currently (and many are hard), I think we can also suggest that contributors can also explore the other labels and pick an issue based on their interests? catherinewu: Since there are not that many issues with 👍 emoji currently (and many are hard), I think we can… | |||||||||||||
yichendaiAuthorUnsubmitted Done Inline ActionsI notice quite a few PRs are related to the integration and libraries. What kind of labels do we want to encourage users to work on? yichendai: I notice quite a few PRs are related to the integration and libraries. What kind of labels do… | |||||||||||||
yichendaiAuthorUnsubmitted Done Inline ActionsChange to: When you are ready for more of a challenge, you can tackle issues with the yichendai: Change to:
When you are ready for more of a challenge, you can tackle issues with the
[most 👍… | |||||||||||||
| We factor engagement into prioritization of the issues. | |||||||||||||
yichendaiAuthorUnsubmitted Done Inline Actions
yichendai: | |||||||||||||
| ## Submit your code | |||||||||||||
catherinewuUnsubmitted Done Inline Actions
catherinewu: | |||||||||||||
Done Inline Actions
inline links, and added oxford comma rexledesma: inline links, and added oxford comma | |||||||||||||
| To submit your code, [fork the Dagster repository](https://help.github.com/en/articles/fork-a-repo), | |||||||||||||
Done Inline Actions
Since you used the acronym PR below, it's useful to define first from its origin (i.e. Pull Request), before referencing it later on rexledesma: Since you used the acronym PR below, it's useful to define first from its origin (i.e. Pull… | |||||||||||||
| create a [new branch](https://help.github.com/en/desktop/contributing-to-projects/creating-a-branch-for-your-work) on your fork, | |||||||||||||
| and open [a Pull Request (PR)](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) | |||||||||||||
| once your work is ready for review. | |||||||||||||
Done Inline Actions
rexledesma: | |||||||||||||
| You will use a PR template to describe your change, highlighting the motivation, context, tests to cover your change, | |||||||||||||
catherinewuUnsubmitted Done Inline ActionsIn the PR template, please describe the change, including the motivation/context, test coverage, and any other relevant information. Please note if the PR is a breaking change or if it is related to an open GitHub issue. catherinewu: In the PR template, please describe the change, including the motivation/context, test coverage… | |||||||||||||
| and any other relevant information. Make sure you tell us if the PR is a breaking change, fixing a bug, adding a new feature | |||||||||||||
| or related to an existing issue. | |||||||||||||
Done Inline Actions
rexledesma: | |||||||||||||
| A Core reviewer will review your PR in around one business day and provide feedback on any changes it requires to be approved. | |||||||||||||
| Once approved and all the tests (including Buildkite!) pass, the reviewer will click the Squash and merge button in Github 🥳. | |||||||||||||
Done Inline Actions
rexledesma: | |||||||||||||
Done Inline ActionsAfter reconsidering, I think we should mention the Swag store after it goes online. yichendai: After reconsidering, I think we should mention the Swag store after it goes online. | |||||||||||||
| Your PR is now merged into Dagster! We’ll shout out for your contribution in the weekly release notes. | |||||||||||||
catherinewuUnsubmitted Done Inline Actionsremove "for" catherinewu: remove "for" | |||||||||||||