Skip to content
This repository was archived by the owner on Sep 1, 2025. It is now read-only.

feat(build): #1108 document contributing#1111

Merged
dsalaza4 merged 1 commit intofluidattacks:mainfrom
rohaquinlop:document-contribution-newcomers
Jun 17, 2023
Merged

feat(build): #1108 document contributing#1111
dsalaza4 merged 1 commit intofluidattacks:mainfrom
rohaquinlop:document-contribution-newcomers

Conversation

@rohaquinlop
Copy link
Contributor

@rohaquinlop rohaquinlop commented Jun 16, 2023

Add new sections to the contributing.md file to help newcomers.

  • Running your local changes
  • Adding yourself to the mailmap
  • Validating commit message
  • DCO
  • Adding and rendering documentation

@rohaquinlop
Copy link
Contributor Author

rohaquinlop commented Jun 16, 2023

@dsalaza4 I don't understand why I'm getting an error when building /lintMarkdown/all

log:

error: builder for '/nix/store/kanp5drhji7a6whqqmpdq89dc08jldpx-lint-markdown-for-all.drv' failed with exit code 1;
       last 10 log lines:
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       For full logs, run 'nix-store -l /nix/store/kanp5drhji7a6whqqmpdq89dc08jldpx-lint-markdown-for-all.drv'.

@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 16, 2023 •
edited
Loading

@dsalaza4 I don't understand why I'm getting an error when building /lintMarkdown/all

log:

error: builder for '/nix/store/kanp5drhji7a6whqqmpdq89dc08jldpx-lint-markdown-for-all.drv' failed with exit code 1;
       last 10 log lines:
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       For full logs, run 'nix-store -l /nix/store/kanp5drhji7a6whqqmpdq89dc08jldpx-lint-markdown-for-all.drv'.

Good catch!

It looks like our lintMarkdown config is outdated:

makes/test/lint-markdown/config.rb

Line 12 in 97ccd84

rule 'MD013', :tables => false, :code_blocks => false

@rohaquinlop
Copy link
Contributor Author

rohaquinlop commented Jun 16, 2023

@dsalaza4 I don't understand why I'm getting an error when building /lintMarkdown/all
log:

error: builder for '/nix/store/kanp5drhji7a6whqqmpdq89dc08jldpx-lint-markdown-for-all.drv' failed with exit code 1;
       last 10 log lines:
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       > MD013 warning: Parameter :code_blocks is deprecated.
       >   Please replace \":code_blocks => false\" by \":ignore_code_blocks => true\" in your configuration.
       For full logs, run 'nix-store -l /nix/store/kanp5drhji7a6whqqmpdq89dc08jldpx-lint-markdown-for-all.drv'.

Good catch!

It looks like our lintMarkdown config is outdated:

makes/test/lint-markdown/config.rb

Line 12 in 97ccd84

rule 'MD013', :tables => false, :code_blocks => false

Thank you, I'm gonna try updating it!

@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from 7bfb29f to 25afdbb Compare June 16, 2023 22:42
dsalaza4
dsalaza4 suggested changes Jun 16, 2023
View reviewed changes
@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 16, 2023 •
edited
Loading 

### Other PR rules

A PR must:

- Only be one commit ahead of master
- Have a title and body equal to its commit message

dsalaza4
dsalaza4 reviewed Jun 16, 2023
View reviewed changes
@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch 3 times, most recently from 8c9eb04 to 20d00b2 Compare June 17, 2023 00:39
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch 2 times, most recently from 195e28a to 68194ce Compare June 17, 2023 01:41
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from 68194ce to 01f08bb Compare June 17, 2023 01:48
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from 01f08bb to b3357b9 Compare June 17, 2023 01:55
dsalaza4
dsalaza4 suggested changes Jun 17, 2023
View reviewed changes
@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

@rohaquinlop We're almost there! 🚀

@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

Move current Examples: to a ### Examples section below ### Other PR Rules

dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

Remove Guidelines section

@rohaquinlop
Copy link
Contributor Author

rohaquinlop commented Jun 17, 2023

Remove Guidelines section

The whole items?

@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from b3357b9 to a957d4f Compare June 17, 2023 02:18
@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from a957d4f to 0401302 Compare June 17, 2023 02:19
@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023 

### Testing new features

- All new [builtins](https://makes.fluidattacks.com/api/builtins/)
must be tested.
- You can add tests to either `/makes.nix` or `/makes/your-builtin/main.nix` depending on the nature of the builtin.
- Make sure to add such tests to the [GitHub Actions pipelines as well](https://github.com/fluidattacks/makes/tree/main/.github/workflows).

@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

Remove Guidelines section

The whole items?

Yes, the entire section

@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from 0401302 to 11b6833 Compare June 17, 2023 02:22
@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

Order:

  1. Testing your local changes
  2. Adding documentation
  3. Testing new features
  4. Adding yourself to the mailmap
  5. Validating commit message (Remove signing your commit, add extra item here)
  6. Other PR Rules
  7. Examples

dsalaza4
dsalaza4 suggested changes Jun 17, 2023
View reviewed changes
@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

Rename Testing new features to Adding tests

@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from 11b6833 to 5944d9d Compare June 17, 2023 02:28
dsalaza4
dsalaza4 suggested changes Jun 17, 2023
View reviewed changes
@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

Rename Validating commit message to Writing a valid commit message.

@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from 5944d9d to cb86254 Compare June 17, 2023 02:36
@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

Move everything under a guidelines section:

## Code contributions

We accept anything that benefits the community,
thanks for sharing your work with the world.
We can discuss implementation details [here][makes_issues].

### Guidelines

1. Write your idea: [here][makes_issues]
1. Fork [Makes on GitHub][makes]
1. [Git][git]-clone your fork
1. Hack as much as you like!
1. [Git][git]-commit your changes.
1. [Git][git]-push changes to your fork
1. Create a **Pull Request** from your fork to [Makes][makes]

#### Testing your local changes

(...)

#### Adding documentation

(...)

#### Examples

(...)

### The legal side of contributions

(...)

@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from cb86254 to 74dae15 Compare June 17, 2023 02:45
dsalaza4
dsalaza4 suggested changes Jun 17, 2023
View reviewed changes
@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from 74dae15 to f89c134 Compare June 17, 2023 02:53
dsalaza4
dsalaza4 reviewed Jun 17, 2023
View reviewed changes
@rohaquinlop
feat(build): fluidattacks#1108 document contributing
ba3b676 
Add new sections to the contributing.md file to help newcomers.

- Running your local changes
- Adding yourself to the mailmap
- Validating commit message
- DCO
- Adding and rendering documentation

Update lintMarkdown config.

Signed-off-by: Robin Quintero <rohaquinlop301@gmail.com>
@rohaquinlop rohaquinlop force-pushed the document-contribution-newcomers branch from f89c134 to ba3b676 Compare June 17, 2023 02:55
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 17, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@dsalaza4
Copy link
Contributor

dsalaza4 commented Jun 17, 2023

LGTM! Merging! Thank you so much for this contribution!

@dsalaza4 dsalaza4 merged commit 39644df into fluidattacks:main Jun 17, 2023
@rohaquinlop rohaquinlop deleted the document-contribution-newcomers branch August 31, 2023 00:35
rohaquinlop added a commit to rohaquinlop/makes that referenced this pull request Feb 19, 2024
@rohaquinlop
feat(back): fluidattacks#1111 test
d7003c3 
- Test

Signed-off-by: Robin Quintero <rohaquinlop301@gmail.com>
rohaquinlop added a commit to rohaquinlop/makes that referenced this pull request Feb 19, 2024
@rohaquinlop
feat(back): fluidattacks#1111 test
596d2e9 
- Test

Signed-off-by: Robin Quintero <rohaquinlop301@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@dsalaza4 dsalaza4 dsalaza4 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rohaquinlop @dsalaza4