Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

67 lines (39 loc) · 4.28 KB
Raw

Welcome to the contributing guide

Getting started

The twitter.js Discord server is a place for users to communicate about anything and everything related to twitter.js. Ask questions here, discuss your ideas with other community members, or just have some fun time in the general channel.

Thank you for investing your time in contributing to the project!

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Issues

Create a new issue

If you spot a problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

  1. Fork the repository.

  • Using GitHub Desktop:

  • Using the command line:

    • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

  • GitHub Codespaces:

    • Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
  1. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
  • Once you submit your PR, a maintainer will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉

Once your PR is merged, your contributions will be publicly visible on the main branch.