Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated README file with table of content and added api endpoints doc… #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

updated README file with table of content and added api endpoints doc… #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing to the challenges platform

A big welcome and thank you for considering contributing to the challenges platform, 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](#getting-started)
* [Issues](#issues)
* [Pull Requests](#pull-requests)
* [Getting Help](#getting-help)
* [Credits](#credits)

## 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](https://auth0.com/blog/a-first-timers-guide-to-an-open-source-project/) 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](https://github.com/susam/gitpr)

1. Fork the repository to your own Github account
2. Clone the project to your machine (`git clone https://github.com/GDGAlgiers/challengesPlatform-api`)
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](https://www.gdgalgiers.com/discord/) and post your question there.

## Credits
This document was templated from [Auth0 contributing guide](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
Loading