From 29366ec2df090a20fbea3997f35ad1d7d0caa7e2 Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Mon, 24 Mar 2025 01:28:28 +0000 Subject: [PATCH 1/2] pages: add menu for contributing guide --- mkdocs.yml | 21 ++++---- .../opportunities/guides/contributor/index.md | 53 ------------------- 2 files changed, 12 insertions(+), 62 deletions(-) delete mode 100644 pages/opportunities/guides/contributor/index.md diff --git a/mkdocs.yml b/mkdocs.yml index 283b8823..1a679275 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,21 +37,24 @@ nav: - OSS Internship: - index: "opportunities/internships/oss/index.md" - Project Ideas: "opportunities/internships/oss/project-ideas/index.md" - - Interns Guide: "opportunities/internships/guides/interns/index.md" - - Projects Ideas Template: "opportunities/internships/templates/projects-ideas/index.md" - - Candidates's Project Proposal Template: "opportunities/internships/templates/candidate-proposal/index.md" + - "Contribution Guidelines": "opportunities/guides/contribution/index.md" + - "Candidates' Guide": "opportunities/internships/guides/interns/index.md" + - "Template: Projects Ideas": "opportunities/internships/templates/projects-ideas/index.md" + - "Template: Candidates's Project Proposal": "opportunities/internships/templates/candidate-proposal/index.md" - OSS Research Seed Internship: - index: "opportunities/internships/oss-research-seed/index.md" - Project Ideas: "opportunities/internships/oss-research-seed/project-ideas/index.md" - - Interns Guide: "opportunities/internships/guides/interns/index.md" - - Projects Ideas Template: "opportunities/internships/templates/projects-ideas/index.md" - - Candidates's Project Proposal Template: "opportunities/internships/templates/candidate-proposal/index.md" + - "Contribution Guidelines": "opportunities/guides/contribution/index.md" + - "Candidates' Guide": "opportunities/internships/guides/interns/index.md" + - "Template: Projects Ideas": "opportunities/internships/templates/projects-ideas/index.md" + - "Template: Candidates's Project Proposal": "opportunities/internships/templates/candidate-proposal/index.md" - Google Summer of Code: - index: "opportunities/gsoc/index.md" - Project Ideas: "opportunities/gsoc/project-ideas/index.md" - - Contributor Guide: "opportunities/gsoc/guides/contributor/index.md" - - Project Idea Template: "opportunities/gsoc/templates/project-ideas.md" - - Contributor Project Proposal Template: "opportunities/gsoc/templates/contributor-proposal.md" + - "Contribution Guidelines": "opportunities/guides/contribution/index.md" + - "Candidates' Guide": "opportunities/gsoc/guides/contributor/index.md" + - "Template: Project Idea": "opportunities/gsoc/templates/project-ideas.md" + - "Template: Candidates Project Proposal": "opportunities/gsoc/templates/contributor-proposal.md" - Partnership: - index: "partnership/index.md" - Partners: "partnership/partners/index.md" diff --git a/pages/opportunities/guides/contributor/index.md b/pages/opportunities/guides/contributor/index.md deleted file mode 100644 index b2200d56..00000000 --- a/pages/opportunities/guides/contributor/index.md +++ /dev/null @@ -1,53 +0,0 @@ -# Contributors Guidelines - -These recommendations are general guidelines from Open Science Labs. Each -project may have its own specific set of recommendations and rules; contributors -should review those for each project. - -## Community Engagement - -- **Communication Platforms:** Each project may use its preferred communication - platform for discussions, such as code repository platforms (GitHub, GitLab, - etc.) or chat-based platforms (Discord, Slack, etc.). Contributors should - verify with the community and mentors which platform is recommended for - seeking assistance, discussing ideas, and requesting reviews. - -- **Collaboration and Support:** Contributors are encouraged to assist others - when possible, as everyone is here to learn and support one another. - -- **Respect and Inclusivity:** Contributors should communicate with kindness and - respect, particularly when interacting with beginners or colleagues for whom - English may not be their first language. Instead of engaging in arguments, - they should offer constructive feedback and encouragement to help others - improve both their language and technical skills. - -- **Channel Usage:** If the primary discussion channel is not the code - repository platform, contributors should use the designated platform to draw - attention to pull requests or issues. Initiating a discussion there prior to - opening issues or pull requests is also expected. - -## Contributions - -- **Task Coordination:** Contributors should avoid duplicating work by verifying - whether someone else is already addressing a task or if the task remains - relevant before beginning work. - -- **Managing Stale Contributions:** Project maintainers may implement mechanisms - to label and close stale issues and pull requests. Some contributors open pull - requests without following up or addressing review recommendations, which can - impede progress. - -- **Code Quality:** Contributors must ensure that `pre-commit` is applied in - their branch before opening a pull request. Additionally, they should adhere - to coding best practices, such as avoiding excessive nesting blocks, following - SOLID principles, and refraining from assigning different types to the same - variable. It is important to consult the project's specific coding guidelines - for additional best practices. - -- **Branch Management:** When updating a branch, contributors should follow the - project's preferred approach, whether that involves using a **rebase** or a - **merge commit**. - -- **Commenting Practices:** Excessive or unnecessary comments should be avoided, - as well the use of emojis in comments, as they may suggest that the content - was generated entirely by an AI. From 9a64f8eb82998ecb6694e044edfcc77ee5cbf58e Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Mon, 24 Mar 2025 01:30:20 +0000 Subject: [PATCH 2/2] pages: add menu for contributing guide --- .../guides/contribution/index.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 pages/opportunities/guides/contribution/index.md diff --git a/pages/opportunities/guides/contribution/index.md b/pages/opportunities/guides/contribution/index.md new file mode 100644 index 00000000..b2200d56 --- /dev/null +++ b/pages/opportunities/guides/contribution/index.md @@ -0,0 +1,53 @@ +# Contributors Guidelines + +These recommendations are general guidelines from Open Science Labs. Each +project may have its own specific set of recommendations and rules; contributors +should review those for each project. + +## Community Engagement + +- **Communication Platforms:** Each project may use its preferred communication + platform for discussions, such as code repository platforms (GitHub, GitLab, + etc.) or chat-based platforms (Discord, Slack, etc.). Contributors should + verify with the community and mentors which platform is recommended for + seeking assistance, discussing ideas, and requesting reviews. + +- **Collaboration and Support:** Contributors are encouraged to assist others + when possible, as everyone is here to learn and support one another. + +- **Respect and Inclusivity:** Contributors should communicate with kindness and + respect, particularly when interacting with beginners or colleagues for whom + English may not be their first language. Instead of engaging in arguments, + they should offer constructive feedback and encouragement to help others + improve both their language and technical skills. + +- **Channel Usage:** If the primary discussion channel is not the code + repository platform, contributors should use the designated platform to draw + attention to pull requests or issues. Initiating a discussion there prior to + opening issues or pull requests is also expected. + +## Contributions + +- **Task Coordination:** Contributors should avoid duplicating work by verifying + whether someone else is already addressing a task or if the task remains + relevant before beginning work. + +- **Managing Stale Contributions:** Project maintainers may implement mechanisms + to label and close stale issues and pull requests. Some contributors open pull + requests without following up or addressing review recommendations, which can + impede progress. + +- **Code Quality:** Contributors must ensure that `pre-commit` is applied in + their branch before opening a pull request. Additionally, they should adhere + to coding best practices, such as avoiding excessive nesting blocks, following + SOLID principles, and refraining from assigning different types to the same + variable. It is important to consult the project's specific coding guidelines + for additional best practices. + +- **Branch Management:** When updating a branch, contributors should follow the + project's preferred approach, whether that involves using a **rebase** or a + **merge commit**. + +- **Commenting Practices:** Excessive or unnecessary comments should be avoided, + as well the use of emojis in comments, as they may suggest that the content + was generated entirely by an AI.