First off, thanks for stopping by! At American, we're passionate about building products that improve the experience of our customers through technology. To do this, we focus on providing our devs with the tools they need to make their work as easy and enjoyable as possible. This project, along with our other open source projects, is something we use internally and we hope it helps you as well.
If you're reading this, you're likely interested in contributing to the project. We're excited about your contribution, but please take a moment to read our the info below before getting started.
Whether you found something that isn't working correctly, something could be improved, or you'd like to suggest a feature, please start with the tasks below.
Search through this project's issues and see if your issues/suggestion is already being tracked. If you find something that matches your issue, join the conversation!
If you didn't find what you were looking for, create a new issue and fill in the required fields to help steer us in the right direction. We'll check it out and get back to you when we can.
If you didn't find what you were looking for, create a new issue with a title starting with [Feature Request] - to help us differentiate it from a bug. Delete the pre-populated description and give us as much information as you can about the feature you'd like to see added. We'll review your request and get back to you. If we feel it's something that fits well with our project goals, we'll verify the
To help you get started, we've marked some tasks with the help-welcome and good-first-task labels. While browsing, make sure there isn't an assignee on the issue and make sure to read through the issue activity to make sure no one else is working on it. When you find something you want to work on, comment on the issue and let the team know you'd like to work on it.
When you're ready to start writing code, make sure you fork this repo and use that fork to make your changes. Once you have something worth sharing, open a Draft Pull Request and make sure to include a reference to the issue (e.g., Fixes #25 at the bottom of the PR description):
- Use the
mainbranch as your PR's base branch - Make sure your PR branch is as up-to-date as possible (we'll handle merge conflicts if one arises)
- Fill out all fields suggested by the template, including links to issue(s) your PR addresses which will help prevent duplication of efforts (e.g.,
Fixes #25at the bottom of the PR description) - If it's your first contribution, make sure your PR includes a modification to
AUTHORS.mdto include your first and last name as well as your email address or your GitHub handle - If you aren't ready for your changes to be merged when you open the pull request, please open a Draft Pull Request.
Note: if you work several issues at once, make sure they're addressed in separate PRs, on separate branches, and all have a base of main from this repo
If your contribution uses code from another source, make sure you properly attribute it. Cite the source of your code where the code is used and include attribution in ThirdPartyNotices.md. Both of these must be present in your PR before we'll merge.
By contributing to this project, you agree to the terms of American’s Contributor License Agreement.