-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cd83669
commit 9b6d9ad
Showing
4 changed files
with
310 additions
and
21 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# New top-level dir creation requires approvals from codeowners. | ||
# [Root-Level] | ||
* @dfinity-lab/teams/release-teams |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
# Contributing to journald-parser | ||
|
||
Welcome to journald-parser! We are excited to have you contribute to our project. By following this guide, you can help us improve the library and make it even better. | ||
|
||
## Table of Contents | ||
|
||
1. [Introduction](#introduction) | ||
2. [Getting Started](#getting-started) | ||
- [Fork the Repository](#fork-the-repository) | ||
- [Clone the Repository](#clone-the-repository) | ||
3. [Making Changes](#making-changes) | ||
4. [Testing](#testing) | ||
5. [Submitting Pull Requests](#submitting-pull-requests) | ||
6. [Contact](#contact) | ||
7. [Acknowledgments](#acknowledgments) | ||
|
||
## Introduction | ||
|
||
journald-parser is a library for parsing systemd journal entries. | ||
|
||
We welcome contributions from everyone, whether you're a seasoned developer or just getting started with open-source. You can contribute in many ways, such as: | ||
|
||
- Fixing bugs | ||
- Adding new features | ||
- Improving documentation | ||
- Enhancing test coverage | ||
- Reporting issues | ||
- Providing feedback | ||
|
||
## Getting Started | ||
|
||
To get started with contributing to journald-parser, follow the steps below: | ||
|
||
### Fork the Repository | ||
|
||
Click the "Fork" button at the top right corner of the repository to create your own fork. | ||
|
||
### Clone the Repository | ||
|
||
Clone your forked repository to your local development environment: | ||
|
||
```bash | ||
git clone https://github.com/your-username/journald-parser.git | ||
cd journald-parser | ||
``` | ||
|
||
Replace `your-username` with your GitHub username. | ||
|
||
## Making Changes | ||
|
||
Now you can make changes to the codebase. Follow these best practices: | ||
|
||
- Create a new branch for each contribution: | ||
|
||
```bash | ||
git checkout -b your-branch-name | ||
``` | ||
|
||
- Write clear and concise commit messages. | ||
- Make atomic commits for logically separate changes. | ||
- Make sure your code is formatted according to the project's style guidelines. | ||
|
||
```bash | ||
cargo clippy | ||
``` | ||
|
||
## Testing | ||
|
||
We highly value the quality of our codebase, and tests play a crucial role in ensuring that quality. Before submitting your changes, run the test suite: | ||
|
||
```bash | ||
cargo test | ||
``` | ||
|
||
Make sure all the tests pass successfully. | ||
|
||
## Submitting Pull Requests | ||
|
||
Once you've made the necessary changes and ensured the tests pass, it's time to submit your contribution: | ||
|
||
1. Push your changes to your forked repository: | ||
|
||
```bash | ||
git push origin your-branch-name | ||
``` | ||
|
||
2. Go to the GitHub repository page for journald-parser. | ||
3. Click on the "Pull Requests" tab and then click "New Pull Request." | ||
4. Select your branch from the dropdown and provide a descriptive title and summary of your changes. | ||
5. If your pull request addresses any issues, reference them using the following syntax: "Fixes #issue_number." | ||
6. Submit the pull request, and it will be reviewed by our team. | ||
|
||
## Contact | ||
|
||
If you have any questions or need further assistance, you can reach out to us via the following channels: | ||
|
||
- GitHub Issues: [journald-parser Issues](https://github.com/dfinity/journald-parser/issues) | ||
|
||
## Acknowledgments | ||
|
||
We would like to express our gratitude to all contributors who help make journald-parser better with their valuable contributions. | ||
|
||
Thank you for being a part of our community and happy contributing! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,204 @@ | ||
Copyright © 2023 DFINITY Foundation | ||
|
||
Each file in this repository is licensed under the license as | ||
described in the LICENSE file in the same directory that contains the | ||
file or, if that doesn't exist, the first LICENSE file in any | ||
higher-level directory. | ||
|
||
Unless stated otherwise as described above, all files in this | ||
directory are licensed under the Apache License, Version 2.0 (the | ||
"License"); you may not use these files except in compliance with the | ||
License. You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Some files in this repository are licensed under the Internet Computer | ||
Community Source License, Version 1.0 of which you can obtain a copy | ||
of at: | ||
|
||
http://dfinity.org/licenses/IC-1.0 | ||
|
||
Some other files are licensed under the Internet Computer Shared | ||
Community Source License, Version 1.0 of which you can obtain a copy | ||
of at: | ||
|
||
http://dfinity.org/licenses/IC-shared-1.0 | ||
|
||
The Apache-2.0 license is also copied below: | ||
|
||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS |
This file was deleted.
Oops, something went wrong.