diff --git a/.github/ISSUE_TEMPLATE/pre-task.md b/.github/ISSUE_TEMPLATE/pre-task.md new file mode 100644 index 00000000..e3506130 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pre-task.md @@ -0,0 +1,12 @@ +--- +name: pre-task +about: r2cn 测试任务模板 +title: "[r2cn-测试任务] " +labels: git, internal, pre-task +assignees: '' + +--- + +[具体描述] XXX 具体功能描述 + +[实现方案] XXX 实现方案描述 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/r2cn.md b/.github/ISSUE_TEMPLATE/r2cn.md new file mode 100644 index 00000000..008d9b25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/r2cn.md @@ -0,0 +1,33 @@ +--- +name: r2cn +about: r2cn 任务模板 +title: "[r2cn] " +labels: r2cn +assignees: '' + +--- + +[__任务__] + +[__任务分值__] 4 分 + +[__背景描述__] + +[__需求描述__] + +[__代码标准__] +1. 所有 __PR__ 提交必须签署 `Signed-off-by` 和 使用 `GPG` 签名，即提交代码时（使用 `git commit` 命令时）至少使用 `-s -S` 两个参数，参考 [Contributing Guide](https://github.com/web3infra-foundation/git-internal/blob/main/docs/contributing.md)； +2. 所有 __PR__ 提交必须通过 `GitHub Actions` 自动化测试，提交 __PR__ 后请关注 `GitHub Actions` 结果； +3. 代码注释均需要使用英文; + +[__PR 提交地址__] 提交到 [git-internal](https://github.com/web3infra-foundation/git-internal) 仓库的 `main` 分支 `` 目录； + +[__开发指导__] +1. 认领任务参考 [r2cn 开源实习计划 - 任务认领与确认](https://r2cn.dev/docs/student/assign); + +[__导师及邮箱__] 请申请此题目的同学使用邮件联系导师，或加入到 [R2CN Discord](https://discord.gg/WRp4TKv6rh) 后在 `#p-mega` 频道和导师交流。 +1. Quanyi Ma +2. Tianxing Ye + +[__备注__] +1. __认领实习任务的同学，必须完成测试任务和注册流程，请参考：__ [r2cn 开源实习计划 - 测试任务](https://r2cn.dev/docs/student/pre-task) 和 [r2cn 开源实习计划 - 学生注册与审核](https://r2cn.dev/docs/student/signup) \ No newline at end of file diff --git a/docs/code-of-conduct.md b/docs/code-of-conduct.md new file mode 100644 index 00000000..d483aca8 --- /dev/null +++ b/docs/code-of-conduct.md @@ -0,0 +1,45 @@ +# CODE OF CONDUCT + +This code of conduct outlines the expected behavior of all members of Web3 Infrastructure Foundation to ensure a safe, productive, and inclusive environment for everyone. + +All members of Web3 Infrastructure Foundation, including employees, contractors, interns, volunteers, and anyone else represents the company, are expected to behave in a professional, respectful, considerate, and collaborative manner. Harassment, discrimination, or toxic behavior of any kind will not be tolerated. + +Web3 Infrastructure Foundation is committed to providing an environment free of harassment and discrimination for everyone, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age, or religion. We do not tolerate harassment of participants in any form. Harassment includes offensive comments related to these characteristics, as well as deliberate intimidation, stalking, following, harassing photography or recording, sustained disruption of talks or other events, inappropriate physical contact, and unwelcome sexual attention. + +If you experience or witness unacceptable behavior, see something that makes you feel unsafe, or have concerns about the well-being of a participant, please report it to Eli Ma or Charles Feng immediately. All reports will be handled confidentially. + +We value diverse opinions, skills, and experiences. We strive to build an inclusive environment where everyone feels safe and respected. Together, we can achieve great things. + +THANK YOU FOR YOUR COOPERATION IN ADVANCING OUR COMMITMENT TO INCLUSION AND RESPECT. + +## Responsibilities + +All members of Web3 Infrastructure Foundation are expected to: + +- Treat all people with respect and consideration, valuing a diversity of views and opinions. + • Communicate openly and thoughtfully. + • Avoid personal attacks directed at other participants. + • Be mindful of your surroundings and your fellow participants. Alert Eli Ma if you notice a dangerous situation or someone in distress. + • Respect personal space and property. + • Refrain from demeaning, discriminatory, or harassing behavior, speech, and imagery. + • Be considerate in your use of space and resources. For example, avoid excessive noise from conversations, laptops, and other electronic devices. Be courteous when taking up shared space such as tables and walkways. + • Follow the instructions of Web3 Infrastructure Foundation staff and security. + • Avoid using language that reinforces social and cultural structures of domination related to gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age, religion, or other personal characteristics. + +## Consequences + +Failure to comply with this Code of Conduct may result in disciplinary action, including removal from Web3 Infrastructure Foundation spaces and events and prohibition from future participation. + +## Contact Information + +If you have questions or concerns about this Code of Conduct, contact Eli Ma or Charles Feng. + +## Enforcement + +Web3 Infrastructure Foundation prioritizes creating a safe and positive experience for everyone. We do not tolerate harassment or discrimination of any kind. + +We expect participants to follow these rules at all Web3 Infrastructure Foundation venues and events. Web3 Infrastructure Foundation staff will enforce this Code of Conduct. + +If a participant engages in harassing or discriminatory behavior, Web3 Infrastructure Foundation staff will take reasonable action they deem appropriate, including warning the offender, expulsion from an event, or banning them from future events. + +At their discretion, Web3 Infrastructure Foundation staff may report offenders to local law enforcement. Web3 Infrastructure Foundation staff may take action against participants for other behaviors that violate this Code of Conduct or negatively impact the safety and inclusion of event participants. \ No newline at end of file diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 00000000..7b5f36f4 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,46 @@ +# Contributing Guide + +## What's the contribution + +Here are some guidelines for contributing to this project: + +1. Report issues/bugs: If you find any issues or bugs in the project, please report them by creating an issue on the issue tracker. Describe the issue in detail and also mention the steps to reproduce it. The more details you provide, the easier it will be for me to investigate and fix the issue. +2. Suggest enhancements: If you have an idea to enhance or improve this project, you can suggest it by creating an issue on the issue tracker. Explain your enhancement in detail along with its use cases and benefits. I appreciate well-thought-out enhancement suggestions. +3. Contribute code: If you want to develop and contribute code, follow these steps: + - Familiarize yourself with the [Code of Conduct](CODE-OF-CONDUCT.md). git-internal has a strict policy against abusive, unethical, or illegal behavior. + - Choose an issue to work on. Issues labeled `good first issue` are suitable for newcomers. You can also look for issues marked `help wanted`. + - Fork the git-internal repository and create a branch for your changes. + - Make your changes and commit them with a clear commit message. Sign the [Developer Certificate of Origin](https://developercertificate.org) (DCO) by adding a `Signed-off-by` line to your commit messages. This certifies that you wrote or have the right to submit the code you are contributing to the project. + - Push your changes to GitHub and open a pull request. + - Respond to any feedback on your pull request. The git-internal maintainers will review your changes and may request modifications before merging. Please ensure your code is properly formatted and follows the same style as the existing codebase. + - Once your pull request is merged, you will be listed as a contributor in the project repository and documentation. +4. Write tutorials/blog posts: You can contribute by writing tutorials or blog posts to help users get started with this project. Submit your posts on the issue tracker for review and inclusion. High quality posts that provide value to users are highly appreciated. +5. Improve documentation: If you find any gaps in the documentation or think any part can be improved, you can make changes to files in the documentation folder and submit a PR. Ensure the documentation is up-to-date with the latest changes. + +Your contributions are highly appreciated. Feel free to ask any questions if you have any doubts or facing issues while contributing. The more you contribute, the more you will learn and improve your skills. + +## DCO & PGP + +To comply with the requirements, contributors must include both a `Signed-off-by` line and a PGP signature in their commit messages. You can find more information about how to generate a PGP key [here](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/generating-a-new-gpg-key). + +Git even has a `-s` command line option to append this automatically to your commit message, and `-S` to sign your commit with your PGP key. For example: + +```bash +$ git commit -S -s -m 'This is my commit message' +``` + +### Rebase the branch + +If you have a local git environment and meet the criteria below, one option is to rebase the branch and add your Signed-off-by lines in the new commits. Please note that if others have already begun work based upon the commits in this branch, this solution will rewrite history and may cause serious issues for collaborators (described in the git documentation under “The Perils of Rebasing”). + +You should only do this if: + +- You are the only author of the commits in this branch +- You are absolutely certain nobody else is doing any work based upon this branch +- There are no empty commits in the branch (for example, a DCO Remediation Commit which was added using `-allow-empty`) + +To add your Signed-off-by line to every commit in this branch: + +- Ensure you have a local copy of your branch by checking out the pull request locally via command line. +- In your local branch, run: `git rebase HEAD~1 --signoff` +- Force push your changes to overwrite the branch: `git push --force-with-lease origin main` \ No newline at end of file