Skip to content

Commit

Permalink
Improving engineering documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
DaleMcGrew committed Dec 3, 2023
1 parent 9204ecb commit 1db1f29
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,21 @@ Automated Installation
## Working with WebApp
1. [Working with WebApp Day-to-Day](docs/working/README_WORKING_WITH_WEB_APP.md)

2. [Debugging Tools and Tips](docs/working/DEBUGGING_TOOLS.md)
2. [What the Heck is a Pull Request?](docs/contributing/PULL_REQUEST_BACKGROUND.md)

3. [Issues and Reporting Bugs](docs/working/ISSUES.md)
3. [Before Your First Pull Request](docs/contributing/PULL_REQUEST_SETUP.md)

4. [Styling Guidelines](docs/working/STYLING.md)
4. [Creating a Pull Request](docs/contributing/CREATING_PULL_REQUEST.md)

5. [Want to sign in with Facebook or Twitter on localhost?](docs/working/SECURE_CERTIFICATE.md)
5. [Debugging Tools and Tips](docs/working/DEBUGGING_TOOLS.md)

6. [Working with ngrok to test on mobile](docs/working/WORKING_WITH_NGROK.md)
6. [Issues and Reporting Bugs](docs/working/ISSUES.md)

7. [Styling Guidelines](docs/working/STYLING.md)

8. [Want to sign in with Facebook or Twitter on localhost?](docs/working/SECURE_CERTIFICATE.md)

9. [Working with ngrok to test on mobile](docs/working/WORKING_WITH_NGROK.md)

Thanks to BrowserStack for helping us with automated testing!

Expand Down
18 changes: 15 additions & 3 deletions docs/contributing/CONTRIBUTING_STANDARDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,24 @@ We value Software Craftsmanship for the We Vote project since it makes working o
* If you need to fix the open source projects we rely on, please make a pull request against that project.


# If there's no issue in github.com, please create one
# Reporting Bugs / Issues

## Let us Know you're working on the issue
## Reporting bugs as member of the engineering team

If you're actively working on an issue, please comment in the issue thread stating that you're working on a fix, or (if you're an official contributor) assign it to yourself. You can also keep the team updated on the work you are doing by attending a team stand-up held on the Daily Hangouts, or post a note in the #agile-stand-up Slack channel. This way, others will know they shouldn't try to work on a fix at the same time.
* We use Jira to track issues with the We Vote website and mobile Apps, thanks to [Atlassian, the makers of Jira](https://www.atlassian.com/software/views/open-source-license-request#/), and their support for open source projects.
* If you're actively working on an issue, please mark it as "Fix in Progress" and assign the issue to yourself.
* Please only "take" one issue at a time, unless you speak to the Engineering Manager first.
* Please keep the team updated on the work you are doing by attending our weekly stand-up meeting, or post a note in the #coding Slack channel.
* We encourage "Find it-Fix-it" for issues you find, if you are able.
* If you would like to report a bug for another engineer to fix, please report it in the #engineering-bug-reports Slack channel

## Reporting bugs if not part the engineering team

* Anyone can report issues [via our support system](https://help.wevote.us/hc/en-us/requests/new)
* Please provide a link to where you saw the issue
* Describe the issue with as much detail as you can -- details really help us reproduce the problem so we can find a fix
* ...and THANK YOU for taking the time to report the issue. We appreciate it!
* Want to join our team? We are 100% volunteer, and [volunteer opportunities are here](https://wevote.applytojob.com/apply/).

# Version numbering

Expand Down

0 comments on commit 1db1f29

Please sign in to comment.