Skip to content

Latest commit

 

History

History
92 lines (55 loc) · 5.36 KB

CONTRIBUTING.md

File metadata and controls

92 lines (55 loc) · 5.36 KB
Raw

Welcome to AntiRecurso contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on AntiRecurso website ✨.

Read our Code of Conduct to keep our community approachable and respectable.

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:

Getting started

Issues

Create a new issue

If you spot a problem with the docs, 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. 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

Make changes locally

Want to contribute? That's great!

Start off by selecting an issue from our issues' page or creating one yourself.

After selecting what you want to do, follow these steps to contribute to the project:

  1. Fork the Repository: Click on the "Fork" button at the top right corner of the repository page. This will create a copy of the repository under your GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine. Open your terminal and use the following command:

git clone https://github.com/your-username/antirecurso.git

Replace your-username with your actual GitHub username.

  1. Create a New Branch: Move into the project directory using the cd antirecurso command. Then create a new branch to work on your feature or fix:
git checkout -b branch-name

Replace branch-name with a descriptive name for your branch.

  1. Make Changes: Now you're ready to add your amazing feature or fix. Make the necessary changes in the codebase.

  2. Commit Changes: Once you're done, commit your changes with a clear and concise commit message:

git commit -m "Add your commit message here"
  1. Push Changes: Push your branch to your forked repository on GitHub:
git push origin branch-name
  1. Create a Pull Request: Go to your forked repository on GitHub and switch to the branch you just pushed. Click on the "New Pull Request" button next to the branch selection dropdown. Provide a descriptive title and detailed description for your pull request, and submit it for review.

Note: We recommend that the branch name looks something like "feat/comments".

Pull Request

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

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • 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 Docs team member will review your proposal. We may ask questions or request 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 🎉🎉 The AntiRecurso Development Team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the AntiRecurso website.