|
1 | 1 | If you want to contribute to Aesara, have a look at the instructions here:
|
2 | 2 | https://aesara.readthedocs.io/en/latest/dev_start_guide.html
|
3 | 3 |
|
4 |
| - |
5 |
| -## Migrating PRs from the original Theano Repo |
6 |
| -Aesara is actively merging new changes. If you have a pull request on the original Theano repository and would like to move it here use the following commands in your local Aesara repository: |
7 |
| - |
8 |
| -``` |
9 |
| -# Go to your Aesara repo |
10 |
| -cd /path/to/your/repo |
11 |
| -
|
12 |
| -# If you'd like to add aesara as a remote |
13 |
| -git remote add aesara [email protected]:aesara-devs/aesara.git |
14 |
| -
|
15 |
| -# Verify the changes. You should see the aesara-devs/aesara.git |
16 |
| -git remote -v |
17 |
| -
|
18 |
| -# Checkout the branch of your request |
19 |
| -git checkout branch_name |
20 |
| -
|
21 |
| -# Push to Aesara |
22 |
| -git push aesara branch_name |
23 |
| -``` |
24 |
| - |
25 |
| -If you would like to make Aesara the new "main" upstream remote: |
26 |
| - |
27 |
| -``` |
28 |
| -git remote set-url upstream [email protected]:aesara-devs/aesara.git |
29 |
| -``` |
| 4 | +## Contribution Expectations |
| 5 | + |
| 6 | +This "Contribution Expectations" section is adapted from [Open Source |
| 7 | +Archetypes](https://opentechstrategies.com/archetypes) and released under a |
| 8 | +[CC-BY-SA](https://creativecommons.org/licenses/by-sa/4.0/) license. |
| 9 | + |
| 10 | +The current focus of the Aesara project is rapid, high quality development of a |
| 11 | +hackable, pure-Python symbolic tensor library with strong support for graph |
| 12 | +rewrites and transpilation to multiple backends including C, |
| 13 | +[JAX](https://github.com/google/jax>), and |
| 14 | +[Numba](https://github.com/numba/numba). |
| 15 | + |
| 16 | +We welcome patches with bug fixes, and we’re happy to answer questions if you’ve |
| 17 | +already put in some effort to find the answer yourself. Please note, however, |
| 18 | +that we’re _unlikely_ to consider new feature contributions or design changes |
| 19 | +unless there’s a strong argument that they are fully in line with our stated |
| 20 | +goals. If you’re not sure, just ask. |
| 21 | + |
| 22 | +Our technical scope and project governance may open up later, of course, For |
| 23 | +now, though, we would characterize this project as being a mix of the "Rocket |
| 24 | +Ship To Mars" and "Specialty Library" archetypes (see |
| 25 | +https://opentechstrategies.com/archetypes for details about RStM and other open |
| 26 | +source archetypes). |
| 27 | + |
| 28 | +## Issues and Discussions |
| 29 | + |
| 30 | +We expect that Github Issues ("issues") indicate work that should be in Aesara |
| 31 | +and can be picked up immediately by a contributor. This includes bugs, which |
| 32 | +indicate something not working as advertised. |
| 33 | + |
| 34 | +Discussions should be created when the scope or direction of the work, though |
| 35 | +within the stated goals of the Aesara project, require additional clarification |
| 36 | +or consideration before a course of action is chosen. |
| 37 | + |
| 38 | +For issues a minimal working example (MWE) is strongly recommended when relevant |
| 39 | +(fixing a typo in the documentation does not require a MWE). For discussions, |
| 40 | +MWEs are generally required. All MWEs must be implemented using Aesara. Please |
| 41 | +do not submit MWEs if they are not implemented in Aesara. In certain cases, |
| 42 | +pseudocode may be acceptable, but an Aesara implementation is always preferable. |
0 commit comments