Skip to content

Latest commit

 

History

History
121 lines (75 loc) · 5.64 KB

CONTRIBUTING.md

File metadata and controls

121 lines (75 loc) · 5.64 KB
Raw

Contributing to the Add to Calendar Button React Repository

You like the project and want to get involved? Awesome! It is always great to get some help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

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 or assessing patches and features.

Also mind that this is a child repository of the popular add-to-calendar-button. In case you want to contribute on the main project, please see the respective documents there.


📄 Using the issue tracker at the parent repository

The issue tracker at the parent repository is the preferred channel for bug reports, precise features requests and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests.

  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

  • Have a look at the Discussions area for everything else, like Q&A, rough ideas, or other requests.


🐞 Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest version.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Therefore, use the official bug issue option at the main repository and fill out all the provided fields


✨ Feature requests

Feature requests are welcome. But take a moment to find out whether 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. Please provide as much detail and context as possible. Feature requests usually belong into the Discussions area at the main project unless they are completely specified.


🧰 Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language). Otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. You can do so via the mentioned discussions board or email us at contributing at add-to-calendar-pro.com;

New development happens on the dev branch first. It is the only branch which gets merged into main!

Mind to run npm install, npm format, and npm run build in order to respect a common code style!

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo
git clone https://github.com/add2cal/add-to-calendar-button-react.git
# Navigate to the newly cloned directory
cd add-to-calendar-button-react
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/add2cal/add-to-calendar-button-react.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout dev
git pull upstream dev

    Also check any other dev_x branch. In doubt, especially if there is a lot of unmerged stuff in them, ask how to proceed!

  3. Create a new topic branch (off the main project dev branch) to contain your feature, change, or fix. The name should start with "dev_", followed by your individual title.

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream dev

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description.


IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the Elastic License 2.0 (ELv2) license.