Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 2.39 KB

contributing.md

File metadata and controls

29 lines (20 loc) · 2.39 KB
Raw

Contributing to Awesome-TON

Thanks for your interest in improving the Awesome-TON project! We value your input and appreciate your support. This document explains our guidelines and the steps for contributing.

Guidelines

Before contributing, please ensure you understand and adhere to the following guidelines:

  1. Check the existing list: Please check if the tool, library, or resource you wish to add is already listed. We aim to avoid duplicates.
  2. Appropriate content only: Only submit tools, libraries, or resources directly related to the TON (Telegram Open Network) ecosystem. General resources should go to other lists.
  3. Ensure it's Awesome: We aim to maintain a high-quality list. Please ensure the tool, library, or resource you're suggesting is widely recognized as useful, valuable, or 'awesome' within the TON ecosystem.
  4. Follow the existing format: Each entry should contain the name of the resource, a link to it, and a brief description.
  5. Adhere to Awesome List's guidelines: This repository aims to be included in the larger Awesome Lists project. Please read and adhere to the awesome manifesto and its pull request guidelines.

How to Contribute

Here are the steps to contribute:

  1. Fork the repository: Use the fork button at the top-right of the Awesome-TON GitHub page to create a copy of the repository on your GitHub account.
  2. Clone the repository: Use git to clone your forked repository to your local machine for editing.
  3. Create a new branch: Make a new branch for each different change you're making.
  4. Make your changes: Add, edit, or remove content as necessary. Ensure your changes adhere to the guidelines above.
  5. Commit your changes: Use git to commit your changes. Include a brief, descriptive commit message.
  6. Push your changes: Use git to push your committed changes to your forked repository on GitHub.
  7. Create a pull request: Go to the Awesome-TON GitHub page, switch to your new branch, and click the "New Pull Request" button.

In the pull request, describe the changes you've made, why you believe they're necessary, and how they adhere to the guidelines.

Thank you for your contribution!