Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 2.98 KB
Raw

Contributing to the web navigation package

A big welcome and thank you for considering contributing to the web navigation package, our open source project! It’s people like you that make it a reality for users in our community.

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing the. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.

Quicklinks

Getting Started

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

  • Search for existing Issues and PRs before creating your own.
  • We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
  • If you've never contributed before, see the first timer's guide on Auth0 Blog for resources and tips on how to get started.

Issues

Issues should be used to report problems, request a new feature, or to discuss potential changes before a PR is created.

Pull Requests

PRs to our repositorties are always welcome and can be a quick way to get your fix or improvement for the project. In general, PRs should:

  • Only fix/add the functionality in question.
  • Address a single concern in the least number of changed lines as possible.
  • Include documentation in the repo for your change.

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

In general, we follow the "fork-and-pull" Git workflow

  1. Fork the repository to your own Github account
  2. Clone the project to your machine (git clone https://github.com/GDGAlgiers/web-navigation-package)
  3. Create a branch locally with a succinct but descriptive name (git checkout -b feature/githubName/AmazingFeature)
  4. Commit changes to the branch (git commit -m 'Add some AmazingFeature')
  5. Following any formatting and testing guidelines specific to this repo
  6. Push changes to your fork (git push origin feature/githubName/AmazingFeature)
  7. Open a PR in our repository.

Getting Help

Join us in the GDG Algiers' Community Discord and post your question there.

Credits

This document was templated from Auth0 contributing guide