This repository has been archived by the owner on Nov 23, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e3bbead
commit 022143f
Showing
10 changed files
with
155 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 19 additions & 8 deletions
27
community/get-involved/learning-at-athens-academy-education/contributing-design.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,26 @@ | ||
| --- | ||
| description: >- | ||
| We're still working on the details, but we'd love to see design-related | ||
| contributions from the Athens community. Start with Discord and the Athens | ||
| design system. | ||
| Good user interface (UI) and user experience (UX) are critical to the Athens | ||
| experience. We're always looking for ways to streamline workflows and make | ||
| features just make sense. | ||
| --- | ||
|
|
||
| # Improve Design | ||
| # Improve design | ||
|
|
||
| * Join our [Discord](https://discord.gg/GCJaV3V) 👾 and see what's happening in the `#🖋-design` channel. | ||
| * Duplicate the [Athens Design System](https://www.figma.com/file/XITWUHZHNJsIbcCsBkOHpZ/Athens-Design-System?node-id=0%3A1) on Figma to get the building blocks for creating UIs and workflows. | ||
| * See previous concepts in the [Product Design Sandbox](https://www.figma.com/file/iCXP6z7H5IAQ6xyFr5AbZ7/Product-Design-Sandbox?node-id=183%3A37). This Figma is no longer actively used, but seeing previous work can help! | ||
| We design Athens in the open and in collaboration with the technical stakeholders to ensure we're delivering intuitive, powerful features. The work itself happens in [Figma](https://www.figma.com/). | ||
|
|
||
| Design System here | ||
| The best kinds of design contributions fit under one of two categories: | ||
|
|
||
| * A wireframe to suggest the UX for a proposed new feature, such as [import/export](https://github.com/athensresearch/athens/discussions/874). | ||
| * A completed, polished UI that would improve the UX for an existing feature. | ||
|
|
||
| Here's how to get started. | ||
|
|
||
| * Get a [Figma account](https://www.figma.com/) if you don't have one already, and familiarize yourself with how it works. | ||
| * Join our [Discord](https://discord.gg/GCJaV3V) and see what's happening in the `#design` channel, or DM **shanberg** directly, to learn about the people and processes in Athens design. | ||
| * Look at the [`#design` tag on GitHub](https://github.com/athensresearch/athens/issues?q=is%3Aopen+is%3Aissue+label%3Adesign) issues to find the latest tasks. | ||
| * Check out the [Athens Design System](https://www.figma.com/file/XITWUHZHNJsIbcCsBkOHpZ/Athens-Design-System?node-id=26%3A446) on Figma to see the building blocks for creating UIs and workflows. This design system isn't currently actively maintained right now, so it's not the only source of truth for Athens design concepts. | ||
| * See design and branding concepts in the [Athens Design Sandbox](https://www.figma.com/file/zpnDCLykhdQyq5FANJb3Vz/Athens-Design-Sandbox?node-id=0%3A1). | ||
| * Get started designing in your own Figma pages! | ||
| * When you have something to share, paste the link in the `#design` channel on[ Discord](https://discord.gg/GCJaV3V) to start the conversation. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 35 additions & 1 deletion
36
...ity/get-involved/learning-at-athens-academy-education/file-and-verify-issues.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,36 @@ | ||
| # File & verify issues | ||
| --- | ||
| description: >- | ||
| We rely on our community to identify and let us know about issues or bugs in | ||
| Athens. | ||
| --- | ||
|
|
||
| # File issues and bugs | ||
|
|
||
| The Athens community uses [GitHub's issues](https://github.com/athensresearch/athens/issues/) feature to identify and track bugs and their associated fixes. We hope you'll help us in this effort to make Athens more stable and usable! | ||
|
|
||
| Issues or bugs can be a lot of different things: | ||
|
|
||
| * A crash in the Athens application. | ||
| * A typo in the Athens interface. | ||
| * Unexpected behavior or design that interrupts how you use Athens. | ||
|
|
||
| If you're not sure, err on the side of filing an issue. | ||
|
|
||
| ### File an issue or bug | ||
|
|
||
| The first step is to search the [existing bugs](https://github.com/athensresearch/athens/issues) to see if your bug or concern has already been reported by another member of the Athens community. If it's already there, feel free to add additional context to the existing issue or simply give it a thumbs-up reaction to showcase to the community that is a repeatable issue. | ||
|
|
||
| If there are no existing issues that match the bug you're experiencing, click [here](https://github.com/athensresearch/athens/issues/new?assignees=&labels=type%3A+%F0%9F%90%9E+bug&template=bug_report.md&title=) to start the bug report. | ||
|
|
||
| Enter a descriptive title. In the text area below, use the provided template to describe your **problem**, add any **screenshots** or **recordings** of the issue, and note which version of Athens you're using. | ||
|
|
||
| {% hint style="info" %} | ||
| To see which version of Athens you're running, open the **Navigation Sidebar** by clicking on the hamburger icon in the top-left corner. The version is shown near the bottom of the Athens interface and follows a pattern like `1.0.0-beta-89`. | ||
| {% endhint %} | ||
|
|
||
| ### Tips for good bug reports | ||
|
|
||
| * Make sure you've searched Athens repository for existing issues or discussions! | ||
| * Keep in mind that what you think of as a bug might actually be a purposeful design decision. | ||
| * Provide information and context in each of the **Problem**, **Screenshots/Demo**, and **Athens Version** headings in the bug report template. | ||
|
|
34 changes: 34 additions & 0 deletions
34
...unity/get-involved/learning-at-athens-academy-education/request-new-features.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,36 @@ | ||
| --- | ||
| description: >- | ||
| If you can't contribute directly for any reason, creating thoughtful feature | ||
| requests is the best way to make Athens better. | ||
| --- | ||
|
|
||
| # Request new features | ||
|
|
||
| The Athens community uses [GitHub's discussions](https://github.com/athensresearch/athens/discussions) feature to propose, organize around, and track progress around feature requests. | ||
|
|
||
| ### Create a new feature request | ||
|
|
||
| The first step is to search existing discussions to see if your feature has been requested by another member of the Athens community. If it's already there, feel free to add additional context to the existing issue or simply give it an emoji reaction to let the community know that you think it's important. | ||
|
|
||
| Click here to [create a new feature request](https://github.com/athensresearch/athens/discussions/new?category=feature-requests). | ||
|
|
||
| Enter a descriptive title, then describe the feature you're looking for in the text area, keeping the below tips in mind. | ||
|
|
||
| ### Tips for good feature requests | ||
|
|
||
| * Make sure you've searched the Athens repository existing feature requests! | ||
| * Try to answer the following question: **What value does this feature provide to users?** | ||
| * Describe **who** will use this feature, as it might not be relevant to everyone. | ||
| * Describe the "expected" behavior. What is the user experience around this feature? | ||
| * If relevant, include screenshots, videos, or links to similar features in other applications that can help illustrate the feature you're requesting. | ||
|
|
||
| ### How feature requests become actively developed | ||
|
|
||
| Requests are turned into issues on three occasions: | ||
|
|
||
| 1. A member of the Athens development community starts working on the requested feature. | ||
| 2. The [Athens core team](../../../company/org-chart/core-team/) puts the feature on the [roadmap](../../../about-us/roadmap.md). | ||
| 3. The Athens core team creates a Gitcoin bounty for the issue and lets another member of the community volunteer themselves. | ||
|
|
||
| Not every feature request can be worked on right away, either due to lack of resources or because the request isn't defined well enough. In either case, we leave the thread open for further discussion and alignment on how to best implement the requested feature. | ||
|
|
48 changes: 47 additions & 1 deletion
48
...nvolved/learning-at-athens-academy-education/review-and-submit-pull-requests.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,48 @@ | ||
| # Review & submit pull requests | ||
| --- | ||
| description: >- | ||
| If you have Clojure experience, we'd love to have you contribute directly to | ||
| the Athens codebase! | ||
| --- | ||
|
|
||
| # Submit and review pull requests | ||
|
|
||
| Athens accepts pull requests \(PRs\) to the [`athensresearch/athens`](https://github.com/athensresearch/athens) open-source repository from anyone in the community with Clojure experience. | ||
|
|
||
| The best way to learn about the status of development of Athens is to [join Discord](https://discord.gg/as9h8yHNfD) and join our weekday standup calls, which happen at 11:30am Eastern time \(UTC -4\). Core team members and contributors also post their standups asynchronously in the `#standup` channel. You can also check out the `#programming` channel for ongoing conversations about Clojure development at Athens. | ||
|
|
||
| Our [roadmap](../../../about-us/roadmap.md) also showcases high-level goals for the core team. | ||
|
|
||
| {% hint style="info" %} | ||
| If you don't yet have Clojure experience and want to contribute, check out [ClojureFam](learn-in-public/clojure/clojurefam/). The program is currently in hiatus, but could be restarted if there is enough interest from the community. [Join our Discord](https://discord.gg/as9h8yHNfD), visit the `#school-builders` channel, and let us know that you're interested, along with your GitHub handle. We'll add you to a "waiting list" and will reach out when we're ready to relaunch. | ||
| {% endhint %} | ||
|
|
||
| The rest of this document assumes that you have your [local development environment](../../../company/athens-research-governance-and-operations/engineering/development.md#running-athens-locally) set up. | ||
|
|
||
| ### Submit a pull request | ||
|
|
||
| #### Find an issue or feature to work on | ||
|
|
||
| The first step in submitting a pull request is to find something to work on. Check out our [issues](https://github.com/athensresearch/athens/issues), and in particular, those labeled with [`#good-first-issue`](https://github.com/athensresearch/athens/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). | ||
|
|
||
| If these resources aren't helpful, ping [Alex](../../../company/org-chart/core-team/alex-iwaniuk.md) \(**@alex-i**\) in the `#programming` channel on [Discord](https://discord.gg/as9h8yHNfD) for additional guidance. | ||
|
|
||
| #### Claim the issue | ||
|
|
||
| Once you found an issue, let the core/triage teams know that you're starting the work. | ||
|
|
||
| In this message, please include the following: | ||
|
|
||
| * Three different implementation approaches. This helps other developers address potential issues with your technical approach before you reach the PR stage. | ||
| * A rough timeframe for completing the work. | ||
| * Any blockers or additional help, such as design, you'll need in order to complete the work. | ||
|
|
||
| Once your proposal is agreed to, we'll assign the issue to you. | ||
|
|
||
| #### Create the PR | ||
|
|
||
| When you're ready, create the PR in GitHub. Please see our [GitHub guidelines](../../../company/athens-research-governance-and-operations/engineering/development.md#git-and-github-style-guide) for details on how to properly title your PR. The core/triage teams will review the PR when resources are available and as the work fits with the overall roadmap. | ||
|
|
||
| ### Review a pull request | ||
|
|
||
| Pull request reviews are reserved for those in the [core team](../../../company/org-chart/core-team/) and a small number of community contributors who have had multiple commits merged into Athens. If you're interested in reviewing PRs, please start by submitting pull requests using the above guidelines and contributing to development-related conversations on [Discord](https://discord.gg/as9h8yHNfD). | ||
|
|
Oops, something went wrong.