Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

73 lines (46 loc) · 3.36 KB

Thank you for considering contributing to this project! Whether you're a developer, researcher, or just someone passionate about improving financial transparency, your contributions are welcome.

Table of Contents

  1. Project Overview
  2. Code of Conduct
  3. How to Contribute
  4. Getting Started with GitHub Desktop
  5. Submitting Your Contributions
  6. License and Attribution

Project Overview

This repository contains both the source code and a growing database of publicly traded companies. The database includes information on transfer agents, investor relations, company shares, and DRS (Direct Registration System) shares. DRS is the only way to register shares in your name and secure property rights over them.

How to Contribute

You might contribute here by:

  • Adding or updating information in the database (e.g., company details, transfer agent data, DRS information).
  • Submitting enhancements, bug fixes, or new features for the source code.
  • Improving documentation and guides.

Getting Started with GitHub Desktop

For those new to contributing or unfamiliar with command-line tools, here’s how you can get started using GitHub Desktop.

  1. Fork the Repository:

    • Go to the repository’s main page on GitHub and click the “Fork” button in the top right. This creates your own copy of the repository.

  2. Clone Your Fork Using GitHub Desktop:

    • Open GitHub Desktop and click “File” > “Clone Repository.”
    • Select your fork from the list and choose a local folder to clone it to.

  3. Create a Branch:

    • Before making changes, create a new branch for your work by selecting “Branch” > “New Branch.” Name your branch based on the feature or update you’re working on (e.g., update-company-info).

  4. Make Your Changes:

    • For database updates: Add or edit the relevant files in the data/ folder.
    • For source code: Make your changes in the src/ folder.
    • Use any spreadsheet or code editors you’re comfortable with.

  5. Commit Your Changes:

    • After making your changes, go to GitHub Desktop and you should see your updated files listed under “Changes.”
    • Write a clear and descriptive commit message, then click “Commit to [your branch name].”

  6. Push Your Branch:

    • Once committed, push your branch to GitHub by clicking “Push origin” in GitHub Desktop.

Submitting Your Contributions

  1. Open a Pull Request:

    • On GitHub, go to your forked repository and click the “Pull Request” button. Select your branch and the base repository’s main branch.
    • Add a title and description explaining your changes.

  2. Review and Feedback:

    • Your pull request will be reviewed. You may be asked to make some adjustments based on feedback.

  3. Merging:

    • Once approved, your contribution will be merged into the project!

License and Attribution

By contributing, you agree that your contributions will be licensed under the respective licenses for the source code and data:

  • Source code contributions will be licensed under the AGPL.
  • Data contributions will be licensed under the ODbL.

For more details, refer to the individual LICENSE files in the src/ and data/ directories.