Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

Latest commit

 

History

History
35 lines (22 loc) · 2.95 KB

contributing.md

File metadata and controls

35 lines (22 loc) · 2.95 KB

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

The following is a set of guidelines for contributing to Awesome Modern Twitter API.

Criteria

Please ensure your Pull Request adheres to the following criteria:

  • One new link per Pull Request. This makes it more straightforward to ask questions, or assess and get feedback from the community about project awesomeness 😎
    • fixes for typos or broken links, and suggested new text content, may skip this requirement. For new section proposals, start with a discussion.
    • per-language library lists should be alphabetical to avoid any kind of preferential presentation.
  • No purely-commercial promotion; apps and links will be vetted for awesomeness 🙂
  • The policy is that the list only includes projects related to Twitter API v2 or greater; therefore, not all Pull Requests may immediately be merged.
    • Twitter API v1.1 projects will not be added. v1.1 is The Past: it is no longer being updated, and it will ultimately be retired. This list is all about the present and future 🚀
    • The goal is to curate a list of maintained and useful resources. In the case of libraries, there should be solid coverage of the API. Dead links or abandoned projects will be removed (please open a PR or an issue if you see one)
  • Use the awesome-linter to check that your entry is well-formatted ✍️

If you want to propose an addition but are not sure how to proceed, please ask a question via the project Discussions on GitHub.

Thank you for your suggestions!

Commit Signing

Please sign all your commits using either GPG keys or a keyless mechanism such as Gitsign. This is important to make sure all contributions come from trusted sources, which will improve the overall security and quality of our project. For more information on how to set up your local Git environment to user commit signing by default, please refer to one of the following guides:

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.