:globe_with_meridians: A simple public IP address API using nothing but NGINX. https://allonsip.sh/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 4.5KB

Contributing to [PROJECT NAME]

Hey :wave:,

Thank you for taking the time to help us make this project better!

We’re thrilled that you’d like to contribute and we’d love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated.

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into our project.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Looking for support?

We’d love to help. Check out the support guidelines.

How to report a bug

Think you found a bug? Please check the list of open issues to see if your bug has already been reported. If it hasn’t, please submit a new issue.

Here are a few tips for writing great bug reports:

  • Describe the specific problem, with screenshots if possible
  • Include the steps to reproduce the bug, what you expected to happen, and what happened instead
  • Check that you are using the latest version of the project and its dependencies
  • Include what version of the project your using, as well as any relevant dependencies
  • Only include one bug per issue. If you have discovered two bugs, please file two issues

If you find a security vulnerability, do not open an issue. Please check our security policy for instructions.

How to suggest a feature or enhancement

If you find yourself wishing for a feature that doesn’t exist in this project, you are probably not alone. There are bound to be others out there with similar needs.

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and goals 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. Please provide as much detail and context as possible, including describing the problem you’re trying to solve.

Open an issue which describes the feature you would like to see, why you want it, how it should work, etc.

Your first contribution

We’d love for you to contribute to the project. Unsure where to begin contributing? You can start by looking through these “good first issue” and “help wanted” issues:

  • Good first issues - issues which should only require a few lines of code and a test or two
  • Help wanted issues - issues which may be a bit more involved, but are specifically seeking community contributions

PS: Feel free to ask for help! :smiley_cat:

How to propose changes

Here’s a few general guidelines for proposing changes:

  • If you are making visual changes, include a screenshot of what the affected element looks like, both before and after.
  • Each pull request should implement one feature or bug fix. If you want to add or fix more than one thing, submit more than one pull request
  • Do not commit changes to files that are irrelevant to your feature or bug fix
  • Don’t bump the version number in your pull request (it will be bumped prior to release)
  • Write a good commit message

At a high level, the process for proposing changes is:

  1. Fork and clone the project
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change
  4. Push to your fork and submit a pull request
  5. Pat your self on the back and wait for your pull request to be reviewed and merged

Interesting in submitting your first Pull Request? It’s easy! You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Code of conduct

This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.