Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
138 lines (96 loc) · 8.6 KB

CONTRIBUTING.md

File metadata and controls

138 lines (96 loc) · 8.6 KB

Contributing to WikiAdviser

First off, thank you for taking the time to contribute! ❤️

We value all types of contributions and encourage everyone to get involved. Please refer to the Table of Contents to find the different ways you can help and detailed guidelines on how to contribute. Reading the relevant section before making your contribution will make it easier for the maintainers and enhance the overall experience for everyone. The community eagerly awaits your contributions! 🎉

If you appreciate the project but don't have time to contribute, that's okay! There are other ways you can support us:

  • Star the project on GitHub
  • Mention this project in your project's README
  • Share it at local meetups, with friends/colleagues and on social networks

Table of Contents

I Have a 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.

I Want To Contribute

Install & Run WikiAdviser for development

  1. Install

    • Setup MediaWiki locally

      pushd docker && docker compose up -d mediawiki mediawiki_db && popd

    • Install dependencies (This project uses pnpm)

      npm install -g pnpm # Install pnpm
npm run install-deps # Install frontend & Supabase

  2. Run WikiAdviser

    npm run dev:supabase > supabase.log # Start Supabase
./generate-env.sh --supabase-creds supabase.log # Update Supabase env variables
./generate-env.sh --bot-creds # Update bot password env variables
npm run dev:frontend # Start the frontend
npm run dev:supabase-functions # Start Supabase functions

Contributor License Agreement (CLA)

By submitting a contribution to the Software, you ("Contributor") agree to the following:

  1. License to the Public: You grant the public a non-exclusive, perpetual, worldwide, royalty-free license to use, modify, and distribute your contribution under the AGPL (Affero General Public License).
  2. License to Ankaboot: You grant Ankaboot ("Publisher") a non-exclusive, perpetual, worldwide, royalty-free license to use, modify, distribute, sublicense, and sell your contribution under any license, including proprietary licenses.
  3. Representations: You confirm that you are the sole author of the contribution and have the right to grant these licenses.

Your First Code Contribution

Follow these steps to make your first code contribution:

  1. Fork this repository
  2. Create a branch for your feature or bug fix (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Pull Request with a clear title and description.

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?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to contact@ankaboot.io.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can’t be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it’s filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical)

Suggesting Enhancements

To suggest an enhancement:

Before Submitting an Enhancement

  • Ensure you are using the latest version.
  • Review the documentation to see if the functionality already exists.
  • Search the issues to see if the enhancement has already been suggested. If so, add your comments there.
  • Determine if your idea fits with the scope and aims of the project. It’s up to you to make a strong case to convince the project’s developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you’re just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to.
  • Explain why this enhancement would be useful to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Attribution

This guide is based on the contributing-gen.