Skip to content

Commit

Permalink
Merge pull request nairuby#76 from JudahSan/main
Browse files Browse the repository at this point in the history 
Hacktoberfest ready: added contribution and code of conduct
  • Loading branch information
@JudahSan
JudahSan authored Oct 9, 2023
2 parents 406e956 + 5cd2b21 commit 20f44c6
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 44 deletions.
3 changes: 3 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,6 @@
/config/credentials/production.key

coverage/

# Ignore JetBrains IDE .idea directory
.idea/
15 changes: 15 additions & 0 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Code of Conduct

Everyone interacting in the ARC project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the following code of conduct:

* Be respectful of others.
* Avoid name-calling, personal attacks, and other forms of harassment.
* Be inclusive and welcoming to everyone, regardless of their background or experience.
* Resolve conflict constructively.
* Use clear and concise language.
* Stay on topic.


### Enforcement

Enforcement of this code of conduct is at the discretion of the maintainers. If a maintainer determines that someone has violated the code of conduct, they may take any action they deem appropriate, including issuing warnings, temporary bans, or permanent bans.
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
## Contributing

Thank you for your interest in contributing to the ARC project! We welcome code and non-code contributions from new and seasoned developers at any career stage, and any sector.
<br>
[Hactoberfest participation guide](https://hacktoberfest.com/participation/#contributors)


### Finding Issues to Work On

We label our issues to help contributors find ones that match their skills and experience level. Here are some labels you might find helpful:


| Difficulty Level | Description | Label |
|------------------|------------------------------------------|----------|
| Easy/ Beginner/ Novice | Issues that are ideal for first-time contributors | ![DifficultyLevelEasy](https://img.shields.io/badge/DifficultyLevelEasy-green.svg?style=for-the-badge)|
| Very Easy | Simple issues that can be fixed quickly | ![DifficultyLevelVeryEasy](https://img.shields.io/badge/DifficultyLevelVeryEasy-619B16?style=for-the-badge)|
| Average/ Normal/ Medium/ Standard/ Intermediate | Issues that require some understanding of the codebase | ![DifficultyLevelAverage](https://img.shields.io/badge/DifficultyLevelAverage-DAD22C?style=for-the-badge&color=fbca04) |
| Hard/ Expert/ Difficult | Issues that require a significant amount of time and effort | ![DifficultyLevelHard](https://img.shields.io/badge/DifficultyLevelHard-E1803C?style=for-the-badge&color=d93f0b) |
| Harder | Very challenging issues that require advanced knowledge | ![DifficultyLevelHarder](https://img.shields.io/badge/DifficultyLevelHarder-C70039?style=for-the-badge)|



### Making Changes

Once you have found an issue you want to work on, follow these steps to make changes:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes to the codebase.
4. Add unit tests for your changes.
5. Commit your changes and push them to your fork.
6. Create a pull request against the upstream repository.


Once you have created a pull request, a maintainer will review your changes. If your changes are approved, they will be merged into the upstream repository.

## Hactoberfest technical contributions


## Non-code and Low-code Contribution

[Low-code and non-code contributions](https://www.youtube.com/watch?v=Z7ppp_DrxyM) are an excellent way to get involved in supporting the ARC project. Here are some examples of ways you can contribute:

LOW-CODE

- Technical documentation
- User experience testing
- Technical blog post or tutorial
- Case studies

NON-CODE CONTRIBUTIONS:

- Writing
- Translating
- Talks or presentations
- Social media
- Blog posts


### Thank You!

Thank you for taking the time to contribute to the [repository name] project! Your contributions help to make the project better for everyone.
59 changes: 15 additions & 44 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,52 +186,23 @@ Thank you for your interest in contributing to the Africa Ruby Community (ARC) P
### Finding Issues to Work On
We label our issues to help contributors find ones that match their skills and experience level. Here are some labels you might find helpful:
We label our issues to help contributors find ones that match their skills and experience level. Here are some labels you might find helpful:
| Difficulty Level | Description | Label |
|------------------|------------------------------------------|----------|
| Easy/ Beginner/ Novice | Issues that are ideal for first-time contributors | ![DifficultyLevelEasy](https://img.shields.io/badge/DifficultyLevelEasy-green.svg?style=for-the-badge)|
| Very Easy | Simple issues that can be fixed quickly | ![DifficultyLevelVeryEasy](https://img.shields.io/badge/DifficultyLevelVeryEasy-619B16?style=for-the-badge)|
| Average/ Normal/ Medium/ Standard/ Intermediate | Issues that require some understanding of the codebase | ![DifficultyLevelAverage](https://img.shields.io/badge/DifficultyLevelAverage-DAD22C?style=for-the-badge&color=fbca04) |
| Hard/ Expert/ Difficult | Issues that require a significant amount of time and effort | ![DifficultyLevelHard](https://img.shields.io/badge/DifficultyLevelHard-E1803C?style=for-the-badge&color=d93f0b) |
| Harder | Very challenging issues that require advanced knowledge | ![DifficultyLevelHarder](https://img.shields.io/badge/DifficultyLevelHarder-C70039?style=for-the-badge)|
| Difficulty Level | Description | Label |
|------------------|------------------------------------------|----------|
| Easy/ Beginner/ Novice | Issues that are ideal for first-time contributors | ![DifficultyLevelEasy](https://img.shields.io/badge/DifficultyLevelEasy-green.svg?style=for-the-badge)|
| Very Easy | Simple issues that can be fixed quickly | ![DifficultyLevelVeryEasy](https://img.shields.io/badge/DifficultyLevelVeryEasy-619B16?style=for-the-badge)|
| Average/ Normal/ Medium/ Standard/ Intermediate | Issues that require some understanding of the codebase | ![DifficultyLevelAverage](https://img.shields.io/badge/DifficultyLevelAverage-DAD22C?style=for-the-badge&color=fbca04) |
| Hard/ Expert/ Difficult | Issues that require a significant amount of time and effort | ![DifficultyLevelHard](https://img.shields.io/badge/DifficultyLevelHard-E1803C?style=for-the-badge&color=d93f0b) |
| Harder | Very challenging issues that require advanced knowledge | ![DifficultyLevelHarder](https://img.shields.io/badge/DifficultyLevelHarder-C70039?style=for-the-badge)|
To guide people in searching for issues using these labels, you can provide the following steps:
To guide people in searching for issues using these labels, you can provide the following steps:
1. Go to the project's repository on GitHub.
2. Click on the `Issues` tab.
3. Use the search bar at the top to search for issues using one or more of the labels listed above.
4. You can refine your search by adding additional keywords or filters, such as language, platform, or component.
5. Once you find an issue you are interested in working on, read through the description and comments to get a better understanding of the problem and any suggested solutions.
6. If you have any questions or need help, leave a comment on the issue and wait for feedback from other contributors or maintainers.

NB: The section below outlines how the README should be written

# README

This README would normally document whatever steps are necessary to get the
application up and running. (guide)

Things you may want to cover:

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...
1. Go to the project's repository on GitHub.
2. Click on the `Issues` tab.
3. Use the search bar at the top to search for issues using one or more of the labels listed above.
4. You can refine your search by adding additional keywords or filters, such as language, platform, or component.
5. Once you find an issue you are interested in working on, read through the description and comments to get a better understanding of the problem and any suggested solutions.
6. If you have any questions or need help, leave a comment on the issue and wait for feedback from other contributors or maintainers.

0 comments on commit 20f44c6

Please sign in to comment.