mirror
/
PowerDNS-Admin
mirror of https://github.com/PowerDNS-Admin/PowerDNS-Admin
1
0
Fork 0
Code Issues Releases Wiki Activity
PowerDNS-Admin/docs/CONTRIBUTING.md

8.0 KiB
Raw Permalink Blame History

Contribution Guide

Looking for help? Try taking a look at the project's Support Guide or joining our Discord Server.

Some general tips for engaging here on GitHub:

  • Register for a free GitHub account if you haven't already.
  • You can use GitHub Markdown for formatting text and adding images.
  • To help mitigate notification spam, please avoid "bumping" issues with no activity. (To vote an issue up or down, use a 👍 or 👎 reaction.)
  • Please avoid pinging members with @ unless they've previously expressed interest or involvement with that particular issue.

Project Update - PLEASE READ!!!

🐛 Reporting Bugs

  • First, ensure that you're running the latest stable version of PDA. If you're running an older version, there's a chance that the bug has already been fixed.

  • Next, search our issues list to see if the bug you've found has already been reported. If you come across a bug report that seems to match, please click "add a reaction" in the top right corner of the issue and add a thumbs up (👍). This will help draw more attention to it. Any comments you can add to provide additional information or context would also be much appreciated.

  • If you can't find any existing issues (open or closed) that seem to match yours, you're welcome to submit a new bug report. Be sure to complete the entire report template, including detailed steps that someone triaging your issue can follow to confirm the reported behavior. (If we're not able to replicate the bug based on the information provided, we'll ask for additional detail.)

  • Some other tips to keep in mind:

    • Error messages and screenshots are especially helpful.
    • Don't prepend your issue title with a label like [Bug]; the proper label will be assigned automatically.
    • Verify that you have GitHub notifications enabled and are subscribed to your issue after submitting.
    • We appreciate your patience as bugs are prioritized by their severity, impact, and difficulty to resolve.

💡 Feature Requests

  • First, check the GitHub issues list to see if the feature you have in mind has already been proposed. If you happen to find an open feature request that matches your idea, click "add a reaction" in the top right corner of the issue and add a thumbs up (👍). This ensures that the issue has a better chance of receiving attention. Also feel free to add a comment with any additional justification for the feature.

  • If you have a rough idea that's not quite ready for formal submission yet, start a GitHub discussion instead. This is a great way to test the viability and narrow down the scope of a new feature prior to submitting a formal proposal, and can serve to generate interest in your idea from other community members.

  • Once you're ready, submit a feature request using this template. Be sure to provide sufficient context and detail to convey exactly what you're proposing and why. The stronger your use case, the better chance your proposal has of being accepted.

  • Some other tips to keep in mind:

    • Don't prepend your issue title with a label like [Feature]; the proper label will be assigned automatically.
    • Try to anticipate any likely questions about your proposal and provide that information proactively.
    • Verify that you have GitHub notifications enabled and are subscribed to your issue after submitting.
    • You're welcome to volunteer to implement your FR, but don't submit a pull request until it has been approved.

⤴️ Submitting Pull Requests

  • Pull requests (a feature of GitHub) are used to propose changes to PDA's code base. Our process generally goes like this:

    • A user opens a new issue (bug report or feature request)
    • A maintainer triages the issue and may mark it as needing an owner
    • The issue's author can volunteer to own it, or someone else can
    • A maintainer assigns the issue to whomever volunteers
    • The issue owner submits a pull request that will resolve the issue
    • A maintainer reviews and merges the pull request, closing the issue

  • It's very important that you not submit a pull request until a relevant issue has been opened and assigned to you. Otherwise, you risk wasting time on work that may ultimately not be needed.

  • New pull requests should generally be based off of the dev branch, rather than master. The dev branch is used for ongoing development, while master is used for tracking stable releases.

  • In most cases, it is not necessary to add a changelog entry: A maintainer will take care of this when the PR is merged. (This helps avoid merge conflicts resulting from multiple PRs being submitted simultaneously.)

  • All code submissions should meet the following criteria (CI will eventually enforce these checks):

    • Python syntax is valid
    • PEP 8 compliance is enforced, with the exception that lines may be greater than 80 characters in length

  • Some other tips to keep in mind:

    • If you'd like to volunteer for someone else's issue, please post a comment on that issue letting us know. (This will allow the maintainers to assign it to you.)
    • All new functionality must include relevant tests where applicable.

⛑️ Become a Maintainer

We're always looking for motivated individuals to join the maintainers team and help drive PDA's long-term development. Some of our most sought-after skills include:

  • Python development with a strong focus on the Flask and Django frameworks
  • Expertise working with SQLite, MySQL, and/or PostgreSQL databases
  • Javascript & TypeScript proficiency
  • A knack for web application design (HTML & CSS)
  • Familiarity with git and software development best practices
  • Excellent attention to detail
  • Working experience in the field of network operations as it relates to the use of DNS (Domain Name System) servers.

We generally ask that maintainers dedicate around four hours of work to the project each week on average, which includes both hands-on development and project management tasks such as issue triage.

We do maintain an active Mattermost instance for internal communication, but we also use GitHub issues for project management.

Some maintainers petition their employer to grant some of their paid time to work on PDA.

Interested? You can contact our lead maintainer, Matt Scott, at admin@powerdnsadmin.org. We'd love to have you on the team!

❤️ Other Ways to Contribute

You don't have to be a developer to contribute to PDA: There are plenty of other ways you can add value to the community! Below are just a few examples:

  • Help answer questions and provide feedback in our GitHub discussions.
  • Write a blog article or record a YouTube video demonstrating how PDA is used at your organization.