Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
82 lines (46 loc) 路 5.95 KB

CONTRIBUTING.md

File metadata and controls

82 lines (46 loc) 路 5.95 KB
Raw

How to contribute

Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!

Even though the projects under this organization mainly targets students of the ESGI school, contributions from others are also welcomed.

Pledge

Please review our Code of Conduct.
It is in effect at all times. We expect it to be honored by everyone who contributes to this project. Acting like an asshole will not be tolerated.

Discussions and asking for help

The main communication channel about maintaining this project is through the Discord server of the Hacklab-ESGI at : https://discord.gg/GCHwE73Wj5 (french speaking)

Ressources

Here is a list of ressources that can help understand the LNK file format :

Report a bug

A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report.

In short, since you are most likely a developer, provide a ticket that you would like to receive.

  • Review the documentation before opening a new issue.

  • Do not open a duplicate issue! Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests.

  • Prefer using reactions, not comments, if you simply want to "+1" an existing issue.

  • Be clear, concise, and descriptive. Provide as much information as you can, including steps to reproduce, stack traces, compiler errors, library versions, OS versions, and screenshots (if applicable).

  • Use GitHub-flavored Markdown. Especially put code blocks and console outputs in backticks (```). This improves readability.

Submitting changes

All contributions will be licensed under the project's license.

We love pull requests! Before forking the repo and creating a pull request for non-trivial changes, it is usually best to first open an issue to discuss the changes, or discuss your intended approach for solving the problem in the comments for an existing issue.

  • Smaller is better. Submit one pull request per bug fix or feature. A pull request should contain isolated changes pertaining to a single bug fix or feature implementation. Do not refactor or reformat code that is unrelated to your change. It is better to submit many small pull requests rather than a single large one. Enormous pull requests will take enormous amounts of time to review, or may be rejected altogether.

  • Coordinate bigger changes. For large and non-trivial changes, open an issue to discuss a strategy with the maintainers. Otherwise, you risk doing a lot of work for nothing!

  • Prioritize understanding over cleverness. Write code clearly and concisely. Remember that source code usually gets written once and read often. Ensure the code is clear to the reader. The purpose and logic should be obvious to a reasonably skilled developer, otherwise you should add a comment that explains it.

  • Follow existing coding style and conventions. Keep your code consistent with the style, formatting, and conventions in the rest of the code base. When possible, these will be enforced with a linter. Consistency makes it easier to review and modify in the future.

  • Add documentation. Document your changes with code doc comments or in existing guides.

  • Use the repo's default branch. Branch from and submit your pull request to the repo's default branch.

  • Resolve any merge conflicts that occur.

  • When writing comments, use properly constructed sentences, including punctuation.

  • If your PR solves an issue, mention it at the end as for example : Resolves: #123

馃拝 Coding Style

  • Please stick with Python's coding style (PEP 8)
  • Run the black formater before each commits

馃弲 Certificate of Origin

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
  2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
  3. The contribution was provided directly to me by some other person who certified (1), (2) or (3) and I have not modified it.
  4. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Credits

This contribution guide has been writing with the help of jessesquires's template