Skip to content

docs(readme): add a code base section to contributing.md #2

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

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

docs(readme): add a code base section to contributing.md #2

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
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@


- [Development Process](#development-process)
- [The Code Base](#the-code-base)
- [Pull Request General Guidelines](#pull-request-general-guidelines)
- [Commit Message Guidelines](#commit-message-guidelines)
- [Commit Message Format](#commit-message-format)
Expand Down Expand Up @@ -49,6 +50,17 @@ New and reopened pull request are automatically added to the board in the In Pro

When the pull request is closed is moved to the Done column automatically. If the pull request closes and issues it is properly stated with the github keywords closes in the pull request it gets automatically moved to the Done column too.

## The Code Base

We make an effort to keep the code clean and readable, with comments as necessary, and also providing appropriate documentation in our readme files. If you are starting out please make sure you read the documentation first. This is a funfunfunction video with **5 tips to quickly understand a new code base** :

<p align="center">
<a href="https://www.youtube.com/watch?v=OnCeaJdd_sY">
<img src="https://monosnap.com/image/vifPIziiPM6pi156S1WkCatqxTLfXa.png" width="600">
</a>
</p>


## Pull Request General Guidelines

* Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned.
Expand Down