Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.81 KB

CONTRIBUTING-en.md

File metadata and controls

56 lines (37 loc) · 2.81 KB

Contributing

En español

First of all, thank you for considering contributing to My Organiser. It's people like you that make Mi Organizador such a great tool.

This guide will help you communicate respecting the time of the people who manage and develop this project. In return, you will receive the same respect, addressing your issue, and helping you to finalise your pull requests.

Issues.

You can open an issue here. Issues will be the default channel to manage the project, report any bugs or ask any questions about the project. We will try to take care of the issue as soon as possible.

Before opening an issue, please make sure that there is no other issue already opened with the same request you are going to make.

The issues will be catalogued according to the predefined tags that come in Github. If you want, you can assign an issue to yourself by mentioning it in the issue thread. Contributions marked with the help wanted tag are especially welcome.

What can you contribute?

Any help is welcome. As mentioned above, you can assign yourself an issue you want to work on by commenting on the issue itself. Or if you have found a bug or lack of documentation, you can open an issue and comment that you are going to work on it.

How can you contribute?

You can follow the following steps to get your repository set up so you can start working on your contribution.

  1. Fork the project, clone it on your computer and set up your remote server:
# Clone your forked project into the current directory
$ git clone https://github.com/<your-user-name>/<repository-name>
# Enter the directory
$ cd <repository-name>
# Assign the original repository to the remote called "upstream"
$ git remote add upstream https://github.com/44r0n/miorganizador
  1. If you cloned the repository a while ago, you should update it to get the latest changes:
$ git checkout main
$ git pull upstream main
  1. Create a branch with the name of what you're going to work on, fix, new feature, documentation, etc:
git checkout -b <branch-name> $ ```bash

  1. Be sure to update or add tests as needed. If your change needs documentation be sure to add it as well.

  2. Publish your changes to your forked repository.

$ git push origin <branch-name>

Open a pull request with a clear title and description.

If during this process you have questions about the change you're going to make, open the pull request in draft mode and comment your question or the help you need.