Skip to content

Fix typos in docs #17

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

Merged
gimseng merged 2 commits into from
Jul 13, 2020
Merged

Fix typos in docs #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
027f0fa
Update CONTRIBUTING.md
gimseng Jul 13, 2020
28181b6
Update CONTRIBUTING.md
gimseng Jul 13, 2020
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
15 changes: 7 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,24 @@ There are two primary ways to help:

## Using the issue tracker

Use the issue tracker to suggest feature requests, report bugs, and ask questions.
Furthermore, propose new exercises to be included int his repo.
One generally uses the issue tracker to suggest feature requests, report bugs, and ask questions.
For our project, you are welcome to propose new exercises to be included in this project by creating an new issue.
Describe what you would like in this exercise and if possible propose what the solution should look like.

Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in
the issue that you will take on that effort, then follow the _Improving the code-base_
guidance below.
If you can write up the codes for the solution, then follow the _Improving the code-base_guidance below.


## Improving the code-base

Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull request (PR).
This is the primary way for you to submit solutions to the exercise in codes.

If you are not familir with git, we follow the general ["fork-and-pull" Git workflow] (https://github.com/susam/gitpr):
If you are not familir with git, we follow the general ["fork-and-pull"](https://github.com/susam/gitpr) git flow:

1. Fork the repository to your own Github account.
2. Clone the project to your machine. Add upstream to the original repo.
3. Create a branch locally with a succinct but descriptive name. It is best practice not to work with the master branch.
4. Commit changes to the branch.
3. Create a branch locally with a succinct but descriptive name (something like `dev-fix-something`). It is best practice not to work with the master branch.
4. Commit changes to the branch. Commit small changes often and commit frequently with succint and clear messages.
5. Following any formatting and testing guidelines specific to this repo.
6. Push changes to your fork. Keep your fork's main development branch updated with upstream's. If there are conflicts, resolve within your own forked version.
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
Expand Down