If you're reading this, you're awesome! Thank you for helping us make this project great and for being a part of the Argos community. Here are a few guidelines that will help you along the way.
If you think you have found a bug or have a new feature idea, please start by making sure it hasn't already been reported or fixed.
Then, you can search through existing issues and PRs to see if someone has written one similar to yours.
Next, please create a new issue that briefly explains the problem and provides some background on the circumstances that triggered it and the steps to reproduce it.
Please don't group multiple topics into one issue.
Argos CI is a community project, so pull requests are always welcome, but before working on a significant change, it is best to open an issue first to discuss it with the maintainers.
When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, don't bundle more than one feature or bug fix per pull request. It's always best to create two smaller PRs than one big one.
When adding new features or modifying existing code, please attempt to include tests to confirm the new behavior.
You should push your local changes to your forked GitHub repository and then open a pull request from your repo to the argos-ci/argos-playwright repository.
- Fork the argos repository on Github
- Clone your fork to your local machine:
git clone --depth 1 [email protected]:<your-login>/argos-playwright.git - Create a branch:
git checkout -b my-topic-branch - Make your changes
- Run the tests:
npm run test - Format and lint the code:
npm run format && npm run lint - Push your branch to github:
git push --set-upstream origin my-topic-branch - Visit github and make your pull request.
If you have an existing local repository, please update it before you start to minimize the chance of merge conflicts.
git remote add upstream git@github.com:argos-ci/argos.git
git checkout main
git pull upstream main
git checkout -b my-topic-branch
npm installPlease follow the coding style of the current code base. Argos uses eslint, so if possible, enable linting in your editor to get real-time feedback.
Linting can be run manually with npm run lint.
When you submit a pull request, the Continuous Integration testing rerun the linting, but hopefully, by then, your code is already clean!
To get a sense of where argos is heading, or for ideas on where you could contribute, take a look at the opened issues.
By contributing your code to the argos-ci/argos GitHub repository, you agree to license your contribution under this repository license.