Skip to content

Commit

Permalink
added contributing and coc to the web-based documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
terylpt committed Oct 28, 2019
1 parent c251cb0 commit 9183396
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 6 deletions.
26 changes: 21 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Contributing In General
Our project welcomes external contributions.

To contribute code or documentation, please submit a [pull request](https://github.com/sysflow-telemetry/sf-docs/pulls).
To contribute code or documentation, please submit a pull request to the proper github repositories.

A good way to familiarize yourself with the codebase and contribution process is
to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/sysflow-telemetry/sf-docs/issues).
to look for and tackle low-hanging fruit in the github issue trackers associated with projects.
Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us.

**Note: We appreciate your effort, and want to avoid a situation where a contribution
Expand All @@ -13,14 +13,14 @@ cannot be accepted at all!**

### Proposing new features

If you would like to implement a new feature, please [raise an issue](https://github.com/sysflow-telemetry/sf-docs/issues)
If you would like to implement a new feature, please raise an issue in the appropriate repository
before sending a pull request so the feature can be discussed. This is to avoid
you wasting your valuable time working on a feature that the project developers
are not interested in accepting into the code base.

### Fixing bugs

If you would like to fix a bug, please [raise an issue](https://github.com/sysflow-telemetry/sf-docs/issues) before sending a
If you would like to fix a bug, please raise an issue in the appropriate repository before sending a
pull request so it can be tracked.

### Merge approval
Expand All @@ -29,7 +29,7 @@ The project maintainers use LGTM (Looks Good To Me) in comments on the code
review to indicate acceptance. A change requires LGTMs from two of the
maintainers of each component affected.

For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
For a list of the maintainers, see the MAINTAINERS.md page in the appropriate repository.

## Legal

Expand Down Expand Up @@ -71,3 +71,19 @@ git commit -s
Please feel free to connect with us on our [Slack channel](https://join.slack.com/t/sysflow-telemetry/shared_invite/enQtODA5OTA3NjE0MTAzLTlkMGJlZDQzYTc3MzhjMzUwNDExNmYyNWY0NWIwODNjYmRhYWEwNGU0ZmFkNGQ2NzVmYjYxMWFjYTM1MzA5YWQ) or
via [email](mailto:sysflow@us.ibm.com). Note that the projects in this repository are not formal products. As a result, the communication channels are to the maintainers and not to a support staff.

## Setup

The documentation is a work in progress but should provide a good overview on how to get started with the project. The Dockerfile also provides a treasure trove of information
on how to build the application, dependencies, and how to test the collector.

## Testing

This project is in its infancy and with limited resources we haven't built many testers for the projects. For the sf-collector, we do have a set of unit tests that test the coverage of most of the events of interest in `sf-collector/tests`.
These tests can be run using the [bats testing framework](https://github.com/bats-core/bats-core). Directions on how to install bats are in the accompanied link. To run the tests, run `bats -t tests.bat` from the tests directory. Note,
that the tests also rely on python3. Before conducting a pull request, these unit tests should be run. Note, there is a version of the docker image with a `testing` tag that contains bats and the unit tests. This might be useful for testing.
Also, conducting a load test and running the application under valgrind is desirable for pull requests.


## Coding style guidelines
We follow the [LLVM Coding standards](https://llvm.org/docs/CodingStandards.html) where possible across the projects. There is a .clang-format file in the master repo [clang-format](https://github.com/sysflow-telemetry/sf-collector/blob/master/src/.clang-format) that can be used in conjunction with [ClangFormat Tool](https://clang.llvm.org/docs/ClangFormat.html) to automatically format code. For linting,
we use [Clang Tidy Linter](https://clang.llvm.org/extra/clang-tidy/). This is referenced in the sf-collector Makefile.
3 changes: 3 additions & 0 deletions docs/coc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Code of Conduct
===============
.. mdinclude:: ../CODE_OF_CONDUCT.md
3 changes: 3 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Contributing
==============
.. mdinclude:: ../CONTRIBUTING.md
4 changes: 3 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ To learn more about each project, please see the table of contents below, or vis
api-utils
deploy
license

contributing
coc

Indices and tables
==================

Expand Down

0 comments on commit 9183396

Please sign in to comment.