Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 5.29 KB

CONTRIBUTING.md

File metadata and controls

110 lines (79 loc) · 5.29 KB

Contributing to Linux Distribution Info

Thank you for considering contributing to our project ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

Contribute

  1. Fork the Repository

    • Click on the "Fork" button at the top right corner of the repository page to create your own copy.

  2. Clone Your Fork

    • Clone your forked repository to your local machine using: 
      git clone https://github.com/your-username/Linux.PackageManager.git
    • Replace your-username with your GitHub username.

  3. Create a Branch

    • Before making changes, create a new branch for your feature or fix: 
      git checkout -b my-new-feature

  4. Make Changes

    • Make the necessary changes using your favorite code editor.

  5. Testing Your Changes

    • Run any tests associated with the project to ensure your changes do not break existing functionality.

  6. Commit Your Changes

    • Commit your changes with a meaningful commit message: 
      git commit -m "Add a new feature"

  7. Push to Your Fork

    • Push your changes to your fork: 
      git push origin my-new-feature

  8. Create a Pull Request

    • Go to the original repository at Linux Distribution Info and click on the "New Pull Request" button. Follow the prompts to create your pull request.

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

Code of Conduct

We expect all contributors to adhere to our code of conduct. Please be respectful, inclusive, and constructive in your interactions.

Code Conventions

  • Use 4 spaces for indentation in your code.
  • Ensure your code is clean and well-commented where necessary.

Thank you for contributing!

Join The Project Team

Feel free to join our team.

Thanks, TirsvadCLI Team