-
Notifications
You must be signed in to change notification settings - Fork 11
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
ead8388
commit ddace6e
Showing
4 changed files
with
428 additions
and
768 deletions.
There are no files selected for viewing
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,60 @@ | ||
# Contributing to The FOSS Club Projects | ||
|
||
Thank you for your interest in contributing to our open-source projects! We appreciate your help in improving the Free and Open Source Software (FOSS) community. Please follow the guidelines below to ensure a smooth contribution process. | ||
|
||
## How to Get Started | ||
|
||
### 1. Find an Issue | ||
Check out the project repositories and find issues labeled with `hacktoberfest` or suitable tasks that align with your skills. We encourage contributors to start with beginner-friendly issues. | ||
|
||
### 2. Fork the Repository | ||
Click the "Fork" button on the top-right of the repository page to make a copy of the project under your GitHub account. | ||
|
||
### 3. Clone Your Fork | ||
Clone the repository to your local machine for development: | ||
|
||
```bash | ||
git clone https://github.com/your-username/repository-name.git | ||
``` | ||
|
||
### 4. Create a Branch | ||
Work on your changes in a new branch to keep your main branch clean: | ||
|
||
```bash | ||
git checkout -b your-branch-name | ||
``` | ||
|
||
### 5. Make Your Changes | ||
Implement your changes based on the issue you are addressing. Ensure your code follows the project’s coding standards. | ||
|
||
### 6. Test Your Changes | ||
Make sure your changes work by running the project tests (if available). Provide additional tests if required. | ||
|
||
### 7. Commit Your Changes | ||
Once you’re happy with your work, commit your changes: | ||
|
||
```bash | ||
git add . | ||
git commit -m "Description of your changes" | ||
``` | ||
|
||
### 8. Push Your Changes | ||
Push your changes to your forked repository: | ||
|
||
```bash | ||
git push origin your-branch-name | ||
``` | ||
|
||
### 9. Open a Pull Request | ||
Submit a pull request (PR) to the original repository for review. Make sure to describe the changes you’ve made and link it to the relevant issue. | ||
|
||
### 10. Wait for Review | ||
The maintainers will review your contribution. If there are any changes requested, please address them promptly. Once approved, your contribution will be merged! | ||
|
||
## Code of Conduct | ||
We follow the [Code of Conduct](link-to-code-of-conduct) to ensure a positive environment for our community. Please be respectful and follow the guidelines. | ||
|
||
## Hacktoberfest Contributions | ||
If you are contributing for Hacktoberfest, make sure the repository is opted-in, and issues are tagged with `hacktoberfest`. Contributions must follow the [Hacktoberfest guidelines](https://hacktoberfest.digitalocean.com/). | ||
|
||
Thank you for contributing! |
Oops, something went wrong.