Skip to content

Commit

Permalink
fix markdown lints
Browse files Browse the repository at this point in the history
  • Loading branch information
themayurkumbhar committed Sep 27, 2019
1 parent 9a1e899 commit e918749
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Please include a summary of the change and which issue is fixed. Please also inc

## Fixes/Implements: # (issue)

## New dependencies introduced?
Please list all decencies introduced in this PR if any with reason.
## If new dependencies introduced
Then please list all decencies introduced in this PR if any with reason.
- Dependency A - Reason

## Checklist:
## Checklist

- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have update README (If needed)
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Create or find an issue you would like to implement:
- create your issue and wait for comments from maintainers
- once the issue is discussed and assigned to you – feel free to implement

# Developing 1build
## Developing 1build

1. Prepare project (Install GoLang 1.9.x)

Expand All @@ -25,11 +25,17 @@ Create or find an issue you would like to implement:
```

- Alternatively `install` 1build from releases to get `1build` configuration for this project

3. Project uses major library to build app - [cobra](https://github.com/spf13/cobra)

4. Project uses - [go modules](https://github.com/golang/go/wiki/Modules) for dependency management.
5. Update necessary documents if needed – Readme etc.

5. Update necessary documents if needed – Readme etc.

6. Submit pull request

7. Make sure all the checks are passing

8. Wait for maintainers to review the code

9. Thanks for you contribution :smile:
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ the things that actually matter.
```console
1build init --name <your_project_name>
```

- Edit file according to project command list, Example of `1build.yaml` for node project:
```yaml
project: Sample JVM Project Name
Expand All @@ -58,7 +59,7 @@ the things that actually matter.
- test: npm run test
```

### Running 1build for the above sample project:
### Running 1build for the above sample project

- building the project
```console
Expand All @@ -84,7 +85,7 @@ the things that actually matter.
```

- To unset multiple commands at once
```console
```console
1build unset lint test build
```

Expand All @@ -99,7 +100,7 @@ and running or you need to clean up the database after running a test harness.
This is where `before` & `after` commands are useful. These commands are both optional – 
you can use one of them, both or neither.

#### Examples:
#### Examples
1. Setting env variables and cleaning those up
```yaml
project: Sample JVM Project Name
Expand Down Expand Up @@ -146,8 +147,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

## Authors

* **Gopinath Langote** - *Initial work & Maintainer* – [Github](https://github.com/gopinath-langote/) –[Twitter](https://twitter.com/GopinathLangote)
* **Alexander Lukianchuk** - *Maintainer* – [Github](https://github.com/landpro) – [Twitter](https://twitter.com/landpro)
- **Gopinath Langote** - *Initial work & Maintainer* – [Github](https://github.com/gopinath-langote/) –[Twitter](https://twitter.com/GopinathLangote)
- **Alexander Lukianchuk** - *Maintainer* – [Github](https://github.com/landpro) – [Twitter](https://twitter.com/landpro)

See also the list of [contributors](https://github.com/gopinath-langote/1build/contributors) who participated in this project.

Expand Down

0 comments on commit e918749

Please sign in to comment.