Skip to content

Latest commit

 

History

History
87 lines (51 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

87 lines (51 loc) · 2.96 KB

Contributing to Citi

Welcome to Citi's Open Source contribution guidelines. We aim to provide simple and easy-to-follow documentation, but suggestions and improvements are always welcome.

⚡ Get started

Create an issue



fork this repository

Fork the repository

Click on the fork button at the top of the page. This will create a copy of this repository under your GitHub account.



Clone the repository

copy URL to clipboard

Clone the repository to your machine. Go to the repository via your GitHub account and click on the Code button.

Run the following command in a terminal/command line:

$ git clone https://github.com/YOUR_GITHUB_USRERNAME/REPO_NAME.git


Make your changes, commit & push

Open a pull request

🎉 Congratulations

⚖️ Code of Conduct

Citi has adopted a Code of Conduct adapted from the Contributor Covenant (v2.0). To report any inappropriate behavior or for any questions related to our Code of Conduct, please contact [email protected].

✍️ DCO (Developer Certificate of Origin)

Open source projects are commonly distributed under an open source license. Any contribution to a project with a license is subsequently licensed under the same terms. Typically, you can find the license for a project at the root of the repository under LICENSE or LICENSE.md.

To accept the terms of a project's license and for us to accept your contribution, you must agree to the Developer Certificate of Origin on each contribution (referred to as per-commit sign-off).

To agree to the DCO, simply add the -s flag each time you create a commit:

$ git commit -s ...

To sign-off historical commits missing a signature, you can run:

$ git rebase --signoff HEAD~4 // ℹ️ Add sign-off on the last 4 commits...

You can verify that you have successfully signed a commit:

$ git log

commit 816e57945c8f4f15b0bbd27e088b7d2bd74df34b
Author: Jane Doe <[email protected]>
Date:   Mon Mar 17 21:52:11 2008 -0700

Signed-off-by: Jane Doe <[email protected]> // Waheey! 🎉 You agreed to the DCO...  

🤝 Responsible Vulnerability Disclosure

If you discover a vulnerability in a Citi repository, please e-mail [email protected].

Thank you for improving the security of Citi and open source!