Thank you for your interest in helping build a robust American Express technological ecosystem. The most impactful way to enrich the innersourced ecosystem at American Express is to create and share great things. Software, services, roadmaps, documentation, post-mortems, project visions, constructive feedback, blog posts, and a near endless list of others can build shared understanding and enable effective collaboration.
To contribute to this repository specifically, helpful guidelines are provided below.
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See "Label reference" for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
- Fork the repository from "Staging" branch.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
-
Make your changes and commit once you are happy with them.
-
Push your commit to your forked repository.
-
Please follow the PEP8 style guide for Python code. We recommend to use the Pylint tool to check your code for style issues before pushing a commit.
-
Please lint your code with Pylint before pushing your changes.
-
Please write unit tests for features you are contributing to ensure good code coverage
-
Naming convention "feature/<< feature-number >>-<< purpose-of-updates >>"
-
Example : feature/0001-add-new-llm›
-
The 0001 is the number to keep track of updates and will be incremented by 1 each time
- To contribute: branch from staging, make your changes, and open a Pull Request (PR) with your changes against
staging. - Contribution to this project is open to all American Express Colleagues.