Skip to content

Latest commit

 

History

History
76 lines (41 loc) · 5.08 KB

CONTRIBUTING.md

File metadata and controls

76 lines (41 loc) · 5.08 KB
Raw

Contributing:

When contributing to this repository, first discuss the change you want to make via issue, email, or any other method with the owners of this repository.

Note that we have a code of conduct; follow it in all your interactions with the project.

Pull Request Process:

  • Check the issues existing in the repository;

  • Make one fork of this repository. When you fork it, it's like a copy of the source code is created in your account, which you can modify without affecting the original repository;

  • Clone copy the repository to your local environment. Open the folder containing the file you want to resolve. Example: The first question from list01 will be in the following path: Pydawan / Lista01_en / l1q01.py. ** Do not delete comment lines with question **, as other people may want to know what you have solved. ** Comments are also important **, so try commenting your code whenever possible so others can learn from it;

  • Once the issue is resolved, compile to test it before requesting a pull-request. Once that done, sync your repository with the original and only after perform a commit to your repository;

  • Later, request a PR for the repository https://github.com/matheusvictor/Pydawan/ with the title resolve # numberDaIssue. Example: resolve # 1;

P.s.: issues need to be resolved using features compatible with Python version 3.7.4 or lower.

Adding new questions to solve:

If you want to add new questions for others to solve, follow these steps:

  • From your local repository, choose one of the list folders and create the file for the question;

  • The level of the question should be according to the level, preferably. So, simpler questions should be in the lista01 and so on. The complexity of the issue can be taken into account from factors such as number of variables used, number of processing to be done until the final result, etc.

    • If you consider complexity beyond current directories, create a special directory to address this issue. That is, if the issue goes beyond the lista04_pt-BR, consider creating a list05_en folder, which will house the suggested question, numbered consecutively with the last one. That is, if the last question is something like l5q10.py, you should create l5q11.py.

  • Name the file following the pattern adopted in existing question files. Example: l1q99.py;

  • That done, open a PR with the commit create question l1q99.py.

Fixing Resolved Issues:

If you notice an error in any of the questions, or believe you can improve the existing statement and / or solution (if any), follow these steps:

  • Correct the wording and / or resolution of the question and open a PR with the commit correct question l1q05.py, for example;

  • Or if you prefer, open an issue titled Fix question lNqXX.py, to identify which question should be fixed. For example: Fix question l1q05.py. In the issue description, describe the problem as much as possible.

Translations:

You can also contribute to this repository by translating the questions into other languages, preferably your native language or some other language that you are fluent. If there is no list of exercises with the language you are looking for, create following the same pattern as the existing one or open an issue!

This topic is still under development!

Opening new issues:

If you noticed something wrong with any of the solutions, utterance or translation, you can report it from a new issue. But before you do so, carefully check that someone else has not reported this issue before, so you can avoid duplicate issues.

This topic will still be developed!

Indicating new support materials:

You can also help by indicating support materials (free, preferably).

This topic is still under development!

Auxiliary materials:

Text Editors & IDEs:

The materials below can help you write and / or compile your Python code (s).:

Git commands:

If you are also starting out with Git, here is a short list of materials that can help you: