Skip to content

Doc contributing #12

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 12, 2020
Merged

Doc contributing #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9836287
Update CONTRIBUTING.md
gimseng Jul 12, 2020
386b4c3
Correct typos
gimseng Jul 12, 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
22 changes: 16 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

There are two primary ways to help:
- Using the issue tracker, and
- Changing the code-base.
- Improving the code-base.


## Using the issue tracker
Expand All @@ -11,14 +11,24 @@ Use the issue tracker to suggest feature requests, report bugs, and ask question
Furthermore, propose new exercises to be included int his repo.

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 _Changing the code-base_
the issue that you will take on that effort, then follow the _Improving the code-base_
guidance below.


## Changing the code-base

Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull request.
## 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 familira with git, we will include more details in a later version of this guidance

If you are not familir with git, 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.
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.
5. Following any formatting and testing guidelines specific to this repo.
6. Push changes to your fork.
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
8. After reviewers approve the PR, your branch (and changes) will be merged to the master branch.